Class LaunchDarklyProvider

Readonly events

Readonly metadata

Readonly runsOn

hooks

• get hooks(): Hook[]

• Returns the OpenFeature hooks registered for this provider. The LaunchDarkly provider does not currently register any provider-level hooks, so this always returns an empty array.

  Returns Hook[]

getClient

• getClient(): LDClient

• Get the LDClient instance used by this provider.

  Returns LDClient

  The client for this provider.

initialize

• initialize(context?): Promise<void>

• Parameters

  • Optional context: EvaluationContext

    Optional

  Returns Promise<void>

onClose

• onClose(): Promise<void>

• Returns Promise<void>

resolveBooleanEvaluation

• resolveBooleanEvaluation(flagKey, defaultValue, context): Promise<ResolutionDetails<boolean>>

• Determines the boolean variation of a feature flag for a context, along with information about how it was calculated.

  If the flag does not evaluate to a boolean value, then the defaultValue will be returned.

  Parameters

  • flagKey: string

    The unique key of the feature flag.

  • defaultValue: boolean

    The default value of the flag, to be used if the value is not available from LaunchDarkly.

  • context: EvaluationContext

    The context requesting the flag. The client will generate an analytics event to register this context with LaunchDarkly if the context does not already exist.

  Returns Promise<ResolutionDetails<boolean>>

  A promise which will resolve to a ResolutionDetails.

resolveNumberEvaluation

• resolveNumberEvaluation(flagKey, defaultValue, context): Promise<ResolutionDetails<number>>

• Determines the numeric variation of a feature flag for a context, along with information about how it was calculated.

  If the flag does not evaluate to a numeric value, then the defaultValue will be returned.

  Parameters

  • flagKey: string

    The unique key of the feature flag.

  • defaultValue: number

    The default value of the flag, to be used if the value is not available from LaunchDarkly.

  • context: EvaluationContext

    The context requesting the flag. The client will generate an analytics event to register this context with LaunchDarkly if the context does not already exist.

  Returns Promise<ResolutionDetails<number>>

  A promise which will resolve to a ResolutionDetails.

resolveObjectEvaluation

• resolveObjectEvaluation<U>(flagKey, defaultValue, context): Promise<ResolutionDetails<U>>

• Determines the object variation of a feature flag for a context, along with information about how it was calculated.

  If the flag does not evaluate to a JSON object value, then the defaultValue will be returned.

  Type Parameters

  • U extends JsonValue

  Parameters

  • flagKey: string

    The unique key of the feature flag.

  • defaultValue: U

    The default value of the flag, to be used if the value is not available from LaunchDarkly.

  • context: EvaluationContext

    The context requesting the flag. The client will generate an analytics event to register this context with LaunchDarkly if the context does not already exist.

  Returns Promise<ResolutionDetails<U>>

  A promise which will resolve to a ResolutionDetails.

resolveStringEvaluation

• resolveStringEvaluation(flagKey, defaultValue, context): Promise<ResolutionDetails<string>>

• Determines the string variation of a feature flag for a context, along with information about how it was calculated.

  If the flag does not evaluate to a string value, then the defaultValue will be returned.

  Parameters

  • flagKey: string

    The unique key of the feature flag.

  • defaultValue: string

    The default value of the flag, to be used if the value is not available from LaunchDarkly.

  • context: EvaluationContext

    The context requesting the flag. The client will generate an analytics event to register this context with LaunchDarkly if the context does not already exist.

  Returns Promise<ResolutionDetails<string>>

  A promise which will resolve to a ResolutionDetails.

track

• track(trackingEventName, context, trackingEventDetails?): void

• Parameters

  • trackingEventName: string

  • context: EvaluationContext

  • Optional trackingEventDetails: TrackingEventDetails

    Optional

  Returns void