Interface LDOverrideSourceExperimental

Supplies flag and segment overrides that take precedence over LaunchDarkly data at evaluation time, on a per-key basis. Overrides exist for resilience during an incident. They let an operator force one or more flags to a known state on a running client, whether or not the client can reach LaunchDarkly.

An override source is not a data source. It takes no part in the data system's initializer and synchronizer pipeline. The override layer it populates has no effect on the client's initialization status or data source status.

Configure an override source with the overrides property of the data system options.

Flag overrides are currently experimental and subject to change.

Hierarchy

  • LDOverrideSource

Methods

Methods

  • Stops the source and releases any resources it holds. The SDK calls this method when the client is closed.

    Returns void

  • Starts supplying overrides to the sink. An implementation performs its initial load and then pushes a full replacement snapshot to the sink whenever its backing data changes, until close is called. A failed load leaves the previously supplied layer untouched by not calling the sink.

    The SDK calls this method once, when the client is created. When the initial load is asynchronous, return a promise that settles when the load completes. The load is part of starting the client: the promise that waitForInitialization returns resolves after it, so an override that is present at startup takes effect by the time initialization is awaited. Evaluation never waits for the load; an evaluation made before it completes reads the layer as it is at that moment.

    Parameters

    Returns void | Promise<void>

Generated using TypeDoc