Interface that extends the LDClient interface to include the identifyResult method.

This is an independent interface for backwards compatibility. Adding this to the LDClient interface would require a breaking change.

Hierarchy

  • LDClientIdentifyResult

Implemented by

Methods

Methods

  • Identifies a context to LaunchDarkly and returns a promise which resolves to an object containing the result of the identify operation.

    Unlike the server-side SDKs, the client-side JavaScript SDKs maintain a current context state, which is set when you call identify().

    Changing the current context also causes all feature flag values to be reloaded. Until that has finished, calls to variation will still return flag values for the previous context. You can await the Promise to determine when the new flag values are available.

    If used with the sheddable option set to true, then the identify operation will be sheddable. This means that if multiple identify operations are done, without waiting for the previous one to complete, then intermediate operations may be discarded.

    Parameters

    Returns Promise<LDIdentifyResult>

    A promise which resolves to an object containing the result of the identify operation. The promise returned from this method will not be rejected.

Generated using TypeDoc