Class OpenFeatureAPI

Hierarchy (view full)

Implements

Properties

_apiEmitter _clientEvents _context _defaultProvider _domainScopedContext _domainScopedProviders _hooks _logger _runsOn _statusEnumType

Accessors

providerMetadata

Methods

_createEventEmitter addHandler addHooks buildAndCacheEventEmitterForClient clearContext clearContexts clearHandlers clearHooks clearProviders clearProvidersAndSetDefault close getAssociatedEventEmitters getClient getContext getHandlers getHooks getProviderForClient getProviderMetadata removeHandler setAwaitableProvider setContext setLogger setProvider setProviderAndWait

Properties

Protected_apiEmitter

_apiEmitter: GenericEventEmitter<ProviderEvents, Record<string, unknown>> = ...

Protected_clientEvents

_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...

Protected_context

_context: EvaluationContext = {}

Protected_defaultProvider

_defaultProvider: ProviderWrapper<Provider, ProviderStatus> = ...

Protected_domainScopedContext

_domainScopedContext: Map<string, EvaluationContext> = ...

Protected_domainScopedProviders

_domainScopedProviders: Map<string, ProviderWrapper<Provider, ProviderStatus>> = ...

Protected_hooks

_hooks: Hook[] = []

Protected_logger

_logger: Logger = ...

Protected_runsOn

_runsOn: Paradigm

Protected_statusEnumType

_statusEnumType: typeof ProviderStatus = ProviderStatus

Accessors

providerMetadata

Methods

Protected_createEventEmitter

addHandler

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. Hooks are executed in the order they were registered. Adding additional hooks will not remove existing hooks. Hooks registered on the global API object run with all evaluations. Hooks registered on the client run with all evaluations on that client.

    Parameters

    • Rest...hooks: Hook[]

      A list of hooks that should always run

    Returns this

    The receiver (this object)

ProtectedbuildAndCacheEventEmitterForClient

clearContext

  • clearContext(): Promise<void>

  • Resets the global evaluation context to an empty object.

    Returns Promise<void>

  • clearContext(domain): Promise<void>

  • Removes the evaluation context for a specific named client.

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

    Returns Promise<void>

clearContexts

  • clearContexts(): Promise<void>

  • Resets the global evaluation context and removes the evaluation context for all domains.

    Returns Promise<void>

clearHandlers

clearHooks

clearProviders

ProtectedclearProvidersAndSetDefault

close

ProtectedgetAssociatedEventEmitters

getClient

  • getClient(domain?, version?): Client

  • A factory function for creating new named OpenFeature clients. Clients can contain their own state (e.g. logger, hook, context). Multiple clients can be used to segment feature flag configuration.

    If there is already a provider bound to this name via this.setProvider setProvider, this provider will be used. Otherwise, the default provider is used until a provider is assigned to that name.

    Parameters

    • Optionaldomain: string

      An identifier which logically binds clients with providers

    • Optionalversion: string

      The version of the client (only used for metadata)

    Returns Client

    OpenFeature Client

getContext

getHandlers

getHooks

ProtectedgetProviderForClient

getProviderMetadata

removeHandler

ProtectedsetAwaitableProvider

setContext

  • setContext(context): Promise<void>

  • Sets the evaluation context globally. This will be used by all providers that have not bound to a domain.

    Parameters

    Returns Promise<void>

    Example

    await OpenFeature.setContext({ region: "us" });
  • setContext(domain, context): Promise<void>

  • Sets the evaluation context for a specific provider. This will only affect providers bound to a domain.

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

    • context: EvaluationContext

      Evaluation context

    Returns Promise<void>

    Example

    await OpenFeature.setContext("test", { scope: "provider" });
    OpenFeature.setProvider(new MyProvider()) // Uses the default context
    OpenFeature.setProvider("test", new MyProvider()) // Uses context: { scope: "provider" }

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger and is passed to various components in the SDK. The logger configured on the global API object will be used for all evaluations, unless overridden in a particular client.

    Parameters

    • logger: Logger

      The logger to be used

    Returns this

    The receiver (this object)

setProvider

  • setProvider(provider): this

  • Sets the default provider for flag evaluations. This provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    Parameters

    • provider: Provider

      The provider responsible for flag evaluations.

    Returns this

    OpenFeature API

  • setProvider(provider, context): this

  • Sets the default provider and evaluation context for flag evaluations. This provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    Parameters

    • provider: Provider

      The provider responsible for flag evaluations.

    • context: EvaluationContext

      {EvaluationContext} The evaluation context to use for flag evaluations.

    Returns this

    OpenFeature API

  • setProvider(domain, provider): this

  • Sets the provider for flag evaluations of providers with the given name. Setting a provider supersedes the current provider used in new and existing clients bound to the same domain.

    Parameters

    • domain: string

      The name to identify the client

    • provider: Provider

      The provider responsible for flag evaluations.

    Returns this

    OpenFeature API

  • setProvider(domain, provider, context): this

  • Sets the provider and evaluation context flag evaluations of providers with the given name. Setting a provider supersedes the current provider used in new and existing clients bound to the same domain.

    Parameters

    • domain: string

      The name to identify the client

    • provider: Provider

      The provider responsible for flag evaluations.

    • context: EvaluationContext

      {EvaluationContext} The evaluation context to use for flag evaluations.

    Returns this

    OpenFeature API

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

  • Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. This provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    Parameters

    • provider: Provider

      The provider responsible for flag evaluations.

    Returns Promise<void>

    Throws

    Uncaught exceptions thrown by the provider during initialization.

  • setProviderAndWait(provider, context): Promise<void>

  • Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. This provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    Parameters

    • provider: Provider

      The provider responsible for flag evaluations.

    • context: EvaluationContext

      The evaluation context to use for flag evaluations.

    Returns Promise<void>

    Throws

    Uncaught exceptions thrown by the provider during initialization.

  • setProviderAndWait(domain, provider): Promise<void>

  • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. A promise is returned that resolves when the provider is ready. Setting a provider supersedes the current provider used in new and existing clients bound to the same domain.

    Parameters

    • domain: string

      The name to identify the client

    • provider: Provider

      The provider responsible for flag evaluations.

    Returns Promise<void>

    Throws

    Uncaught exceptions thrown by the provider during initialization.

  • setProviderAndWait(domain, provider, context): Promise<void>

  • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. A promise is returned that resolves when the provider is ready. Setting a provider supersedes the current provider used in new and existing clients bound to the same domain.

    Parameters

    • domain: string

      The name to identify the client

    • provider: Provider

      The provider responsible for flag evaluations.

    • context: EvaluationContext

      The evaluation context to use for flag evaluations.

    Returns Promise<void>

    Throws

    Uncaught exceptions thrown by the provider during initialization.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods