Interface LDDebugOverrideExperimental

Debug interface for plugins that need to override flag values during development. This interface provides methods to temporarily override flag values that take precedence over the actual flag values from LaunchDarkly. These overrides are useful for testing, development, and debugging scenarios.

This interface is experimental and intended for use by LaunchDarkly tools at this time. The API may change in future versions.

interface LDDebugOverride {
    clearAllOverrides(): void;
    getAllOverrides(): LDFlagSet;
    removeOverride(flagKey): void;
    setOverride(flagKey, value): void;
}

Methods

clearAllOverrides getAllOverrides removeOverride setOverride

Methods

clearAllOverrides

  • clearAllOverrides(): void

  • Clear all override values, reverting all flags to their real values.

    Returns void

getAllOverrides

  • getAllOverrides(): LDFlagSet

  • Get all currently active flag overrides.

    Returns LDFlagSet

    An object containing all active overrides as key-value pairs, where keys are flag keys and values are the overridden flag values. Returns an empty object if no overrides are active.

removeOverride

  • removeOverride(flagKey): void

  • Remove an override value for a flag, reverting to the real flag value.

    Parameters

    • flagKey: string

      The flag key.

    Returns void

setOverride

  • setOverride(flagKey, value): void

  • Set an override value for a flag that takes precedence over the real flag value.

    Parameters

    • flagKey: string

      The flag key.

    • value: any

      The override value.

    Returns void

Settings

Member Visibility

Theme

On This Page

clearAllOverridesgetAllOverridesremoveOverridesetOverride