Class LaunchDarklyProvider

Readonlyevents

Readonlymetadata

ReadonlyrunsOn

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?: EvaluationContext): Promise<void>

  A function used to setup the provider. Called by the SDK after the provider is set if the provider's status is NOT_READY. When the returned promise resolves, the SDK fires the ProviderEvents.Ready event. If the returned promise rejects, the SDK fires the ProviderEvents.Error event. Use this function to perform any context-dependent setup within the provider.

  Parameters

  • Optionalcontext: EvaluationContext

    the global evaluation context

  Returns Promise<void>

onClose

• onClose(): Promise<void>

  A function used to shut down the provider. Called when this provider is replaced with a new one, or when the OpenFeature is shut down.

  Returns Promise<void>

resolveBooleanEvaluation

• resolveBooleanEvaluation(
      flagKey: string,
      defaultValue: boolean,
      context: EvaluationContext,
  ): 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: string,
      defaultValue: number,
      context: EvaluationContext,
  ): 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 extends JsonValue>(
      flagKey: string,
      defaultValue: U,
      context: EvaluationContext,
  ): 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: string,
      defaultValue: string,
      context: EvaluationContext,
  ): 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: string,
      context: EvaluationContext,
      trackingEventDetails?: TrackingEventDetails,
  ): void

  Track a user action or application state, usually representing a business objective or outcome.

  Parameters

  • trackingEventName: string
  • context: EvaluationContext
  • OptionaltrackingEventDetails: TrackingEventDetails

  Returns void