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

Implements

Constructors

  • Creates the client object synchronously. No async, no network calls.

    Parameters

    Returns LDClientImpl

Properties

_baseHeaders: any
_checkedContext?: any
_config: any
_createIdentifyPromise: any
_diagnosticsManager?: any
_eventFactoryDefault: any
_eventFactoryWithReasons: any
_eventProcessor?: any
_eventSendingEnabled: any
_flagManager: any
_handleInspectionChanged: any
_highTimeoutThreshold: any
_hookRunner: any
_identifyQueue: any
_inspectorManager: any
_typedEval: any
_uncheckedContext?: any
_variationInternal: any
autoEnvAttributes: AutoEnvAttributes
dataManager: DataManager
emitter: LDEmitter
environmentMetadata: LDPluginEnvironmentMetadata
logger: LDLogger
platform: Platform
sdkKey: string

Methods

  • Parameters

    Returns void

  • Returns LDFlagSet

  • Parameters

    • key: string
    • defaultValue: boolean

    Returns boolean

  • Parameters

    • key: string
    • defaultValue: boolean

    Returns LDEvaluationDetailTyped<boolean>

  • Returns Promise<void>

  • Returns Promise<{
        error?: Error;
        result: boolean;
    }>

  • Returns undefined | LDContext

  • Returns undefined | Context

  • Identifies a context to LaunchDarkly. See LDClient.identify.

    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.

    It is recommended to use the identifyResult method instead when the operation is sheddable. In a future release, all identify operations will default to being sheddable.

    Parameters

    Returns Promise<void>

    A Promise which resolves when the flag values for the specified context are available. It rejects when:

    1. The context is unspecified or has no key.

    2. The identify timeout is exceeded. In client SDKs this defaults to 5s. You can customize this timeout with identifyOptions.

    3. A network error is encountered during initialization.

  • 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.

  • Parameters

    • key: string
    • defaultValue: unknown

    Returns unknown

  • Parameters

    • key: string
    • defaultValue: unknown

    Returns LDEvaluationDetailTyped<unknown>

  • Parameters

    • key: string
    • defaultValue: number

    Returns number

  • Parameters

    • key: string
    • defaultValue: number

    Returns LDEvaluationDetailTyped<number>

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Enable/Disable event sending.

    Parameters

    • enabled: boolean

      True to enable event processing, false to disable.

    • flush: boolean

      True to flush while disabling. Useful to flush on certain state transitions.

    Returns void

  • Parameters

    • key: string
    • defaultValue: string

    Returns string

  • Parameters

    • key: string
    • defaultValue: string

    Returns LDEvaluationDetailTyped<string>

  • Parameters

    • key: string
    • Optional data: any
      Optional
    • Optional metricValue: number
      Optional

    Returns void

  • Parameters

    • flagKey: string
    • Optional defaultValue: any
      Optional

    Returns any

  • Parameters

    • flagKey: string
    • Optional defaultValue: any
      Optional

    Returns LDEvaluationDetail

Generated using TypeDoc