Class OpenFeatureCommonAPI<S, P, H>`Abstract`

Type Parameters

S extends AnyProviderStatus
P extends CommonProvider<S> = CommonProvider<S>
H extends BaseHook = BaseHook

Hierarchy (view full)

OpenFeatureCommonAPI
- OpenFeatureAPI

Implements

Constructors

constructor

new OpenFeatureCommonAPI<S, P, H>(category): OpenFeatureCommonAPI<S, P, H>
Type Parameters
- S extends AnyProviderStatus
- P extends CommonProvider<S, P> = CommonProvider<S>
- H extends BaseHook<FlagValue, unknown, unknown, H> = BaseHook<FlagValue, unknown, unknown>
Parameters
- category: Paradigm
Returns OpenFeatureCommonAPI<S, P, H>
- Defined in packages/shared/src/open-feature.ts:106

Properties

`Protected` `Abstract` `Readonly` _apiEmitter

_apiEmitter: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>

`Private` `Readonly` _clientEventHandlers

_clientEventHandlers: Map<undefined | string, [AnyProviderEvent, EventHandler<ProviderEvents | ClientProviderEvents>][]> = ...

`Protected` _clientEvents

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

`Protected` _context

_context: EvaluationContext = {}

`Protected` `Abstract` _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

`Protected` _domainScopedContext

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

`Protected` `Abstract` `Readonly` _domainScopedProviders

_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>

`Protected` _hooks

_hooks: H[] = []

`Protected` _logger

_logger: Logger = ...

`Protected` _runsOn

_runsOn: Paradigm

`Protected` `Abstract` `Readonly` _statusEnumType

_statusEnumType: typeof ClientProviderStatus | typeof ProviderStatus

Accessors

`Private` allProviders

get allProviders(): P[]
Returns P[]
- Defined in packages/shared/src/open-feature.ts:423

providerMetadata

get providerMetadata(): ProviderMetadata
Get metadata about the default provider.

Returns ProviderMetadata
Provider Metadata
- Defined in packages/shared/src/open-feature.ts:133

Methods

`Protected` `Abstract` _createEventEmitter

_createEventEmitter(): GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>
Returns GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>
- Defined in packages/shared/src/open-feature.ts:92

addHandler

addHandler<T>(eventType, handler): void
Adds a handler for the given provider event type. The handlers are called in the order they have been added. API (global) events run for all providers.
Type Parameters
- T extends AnyProviderEvent
Parameters
- eventType: T
  The provider event type to listen to
- handler: EventHandler<ProviderEvents | ClientProviderEvents>
  The handler to run on occurrence of the event type
Returns void
Implementation of Eventing.addHandler
- Defined in packages/shared/src/open-feature.ts:154

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: H[]
  A list of hooks that should always run
Returns this
The receiver (this object)
Implementation of EvaluationLifeCycle.addHooks
- Defined in packages/shared/src/open-feature.ts:110

`Protected` buildAndCacheEventEmitterForClient

buildAndCacheEventEmitterForClient(domain?): GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>
Parameters
- Optional domain: string
Returns GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>
- Defined in packages/shared/src/open-feature.ts:314

clearHandlers

clearHandlers(): void
Removes all event handlers.

Returns void
- Defined in packages/shared/src/open-feature.ts:186

clearHooks

clearHooks(): this
Clears all the hooks that are registered on this receiver.

Returns this
The receiver (this object)
Implementation of EvaluationLifeCycle.clearHooks
- Defined in packages/shared/src/open-feature.ts:119

`Protected` clearProvidersAndSetDefault

clearProvidersAndSetDefault(defaultProvider): Promise<void>
Parameters
- defaultProvider: P
Returns Promise<void>
- Defined in packages/shared/src/open-feature.ts:408

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/shared/src/open-feature.ts:388

`Protected` getAssociatedEventEmitters

getAssociatedEventEmitters(domain): GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>[]
Parameters
- domain: undefined | string
Returns GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>[]
- Defined in packages/shared/src/open-feature.ts:352

getHandlers

getHandlers<T>(eventType): EventHandler<ProviderEvents | ClientProviderEvents>[]
Gets the current handlers for the given provider event type.
Type Parameters
- T extends AnyProviderEvent
Parameters
- eventType: T
  The provider event type to get the current handlers for
Returns EventHandler<ProviderEvents | ClientProviderEvents>[]
The handlers currently attached to the given provider event type
Implementation of Eventing.getHandlers
- Defined in packages/shared/src/open-feature.ts:195

getHooks

getHooks(): H[]
Access all the hooks that are registered on this receiver.

Returns H[]
A list of the client hooks
Implementation of EvaluationLifeCycle.getHooks
- Defined in packages/shared/src/open-feature.ts:115

`Protected` getProviderForClient

getProviderForClient(domain?): P
Parameters
- Optional domain: string
Returns P
- Defined in packages/shared/src/open-feature.ts:306

getProviderMetadata

getProviderMetadata(domain?): ProviderMetadata
Get metadata about a registered provider using the client name. An unbound or empty client name will return metadata from the default provider.
Parameters
- Optional domain: string
  An identifier which logically binds clients with providers
Returns ProviderMetadata
Provider Metadata
- Defined in packages/shared/src/open-feature.ts:143

`Private` getUnboundEmitters

getUnboundEmitters(): GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>[]
Returns GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>[]
- Defined in packages/shared/src/open-feature.ts:340

`Private` handleShutdownError

handleShutdownError(provider, err): void
Parameters
- provider: P
- err: unknown
Returns void
- Defined in packages/shared/src/open-feature.ts:430

removeHandler

removeHandler<T>(eventType, handler): void
Removes a handler for the given provider event type.
Type Parameters
- T extends AnyProviderEvent
Parameters
- eventType: T
  The provider event type to remove the listener for
- handler: EventHandler<ProviderEvents | ClientProviderEvents>
  The handler to remove for the provider event type
Returns void
Implementation of Eventing.removeHandler
- Defined in packages/shared/src/open-feature.ts:179

`Protected` setAwaitableProvider

setAwaitableProvider(domainOrProvider?, providerOrUndefined?): void | Promise<void>
Parameters
- Optional domainOrProvider: string | P
- Optional providerOrUndefined: P
Returns void | Promise<void>
- Defined in packages/shared/src/open-feature.ts:211

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)
Implementation of ManageLogger.setLogger
- Defined in packages/shared/src/open-feature.ts:124

`Abstract` setProvider

setProvider(clientOrProvider?, providerContextOrUndefined?, contextOrUndefined?): this
Parameters
- Optional clientOrProvider: string | P
- Optional providerContextOrUndefined: EvaluationContext | P
- Optional contextOrUndefined: EvaluationContext
Returns this
- Defined in packages/shared/src/open-feature.ts:205

`Abstract` setProviderAndWait

setProviderAndWait(clientOrProvider?, providerContextOrUndefined?, contextOrUndefined?): Promise<void>
Parameters
- Optional clientOrProvider: string | P
- Optional providerContextOrUndefined: EvaluationContext | P
- Optional contextOrUndefined: EvaluationContext
Returns Promise<void>
- Defined in packages/shared/src/open-feature.ts:199

`Private` transferListeners

transferListeners(oldProvider, newProvider, domain, emitters): void
Parameters
- oldProvider: P
- newProvider: P
- domain: undefined | string
- emitters: (undefined | GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>)[]
Returns void
- Defined in packages/shared/src/open-feature.ts:356

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns OpenFeatureCommonAPI<S, P, H>

Properties

Protected Abstract Readonly _apiEmitter

Private Readonly _clientEventHandlers

Protected _clientEvents

Protected _context

Protected Abstract _defaultProvider

Protected _domainScopedContext

Protected Abstract Readonly _domainScopedProviders

Protected _hooks

Protected _logger

Protected _runsOn

Protected Abstract Readonly _statusEnumType

Accessors

Private allProviders

Returns P[]

providerMetadata

Returns ProviderMetadata

Methods

Protected Abstract _createEventEmitter

Returns GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>

addHandler

Type Parameters

Parameters

Returns void

addHooks

Parameters

Returns this

Protected buildAndCacheEventEmitterForClient

Parameters

Returns GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>

clearHandlers

Returns void

clearHooks

Returns this

Protected clearProvidersAndSetDefault

Parameters

Returns Promise<void>

close

Returns Promise<void>

Protected getAssociatedEventEmitters

Parameters

Returns GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>[]

getHandlers

Type Parameters

Parameters

Returns EventHandler<ProviderEvents | ClientProviderEvents>[]

getHooks

Returns H[]

Protected getProviderForClient

Parameters

Returns P

getProviderMetadata

Parameters

Returns ProviderMetadata

Private getUnboundEmitters

Returns GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>[]

Private handleShutdownError

Parameters

Returns void

removeHandler

Type Parameters

Parameters

Returns void

Protected setAwaitableProvider

Parameters

Returns void | Promise<void>

Class OpenFeatureCommonAPI<S, P, H>`Abstract`

`Protected` `Abstract` `Readonly` _apiEmitter

`Private` `Readonly` _clientEventHandlers

`Protected` _clientEvents

`Protected` _context

`Protected` `Abstract` _defaultProvider

`Protected` _domainScopedContext

`Protected` `Abstract` `Readonly` _domainScopedProviders

`Protected` _hooks

`Protected` _logger

`Protected` _runsOn

`Protected` `Abstract` `Readonly` _statusEnumType

`Private` allProviders

`Protected` `Abstract` _createEventEmitter

`Protected` buildAndCacheEventEmitterForClient

`Protected` clearProvidersAndSetDefault

`Protected` getAssociatedEventEmitters

`Protected` getProviderForClient

`Private` getUnboundEmitters

`Private` handleShutdownError

`Protected` setAwaitableProvider

`Abstract` setProvider

`Abstract` setProviderAndWait

`Private` transferListeners