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, Record<string, unknown>, unknown, unknown, H> = BaseHook<FlagValue, Record<string, unknown>, unknown, unknown>
Parameters
- category: Paradigm
Returns OpenFeatureCommonAPI<S, P, H>
- Defined in packages/shared/src/open-feature.ts:109

Properties

`Protected` `Abstract` `Readonly`_apiEmitter

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

`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 ProviderStatus | typeof ServerProviderStatus

Accessors

providerMetadata

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

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

Methods

`Protected` `Abstract`_createEventEmitter

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

addHandler

addHandler<T>(eventType, handler, options?): 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<ServerProviderEvents | ProviderEvents>
  The handler to run on occurrence of the event type
- Optionaloptions: EventOptions
  Optional options such as signal for aborting
Returns void
Implementation of Eventing.addHandler
- Defined in packages/shared/src/open-feature.ts:158

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:113

`Protected`buildAndCacheEventEmitterForClient

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

clearHandlers

clearHandlers(): void
Removes all event handlers.

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

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:122

`Protected`clearProvidersAndSetDefault

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

close

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

`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:361

getHandlers

getHandlers<T>(eventType): EventHandler<ServerProviderEvents | ProviderEvents>[]
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<ServerProviderEvents | ProviderEvents>[]
The handlers currently attached to the given provider event type
Implementation of Eventing.getHandlers
- Defined in packages/shared/src/open-feature.ts:204

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:118

`Protected`getProviderForClient

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

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
- Optionaldomain: string
  An identifier which logically binds clients with providers
Returns ProviderMetadata
Provider Metadata
- Defined in packages/shared/src/open-feature.ts:146

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<ServerProviderEvents | ProviderEvents>
  The handler to remove for the provider event type
Returns void
Implementation of Eventing.removeHandler
- Defined in packages/shared/src/open-feature.ts:188

`Protected`setAwaitableProvider

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

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:127

`Abstract`setProvider

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

`Abstract`setProviderAndWait

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

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

Protected_clientEvents

Protected_context

Protected Abstract_defaultProvider

Protected_domainScopedContext

Protected Abstract Readonly_domainScopedProviders

Protected_hooks

Protected_logger

Protected_runsOn

Protected Abstract Readonly_statusEnumType

Accessors

providerMetadata

Returns ProviderMetadata

Methods

Protected Abstract_createEventEmitter

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

addHandler

Type Parameters

Parameters

Returns void

addHooks

Parameters

Returns this

ProtectedbuildAndCacheEventEmitterForClient

Parameters

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

clearHandlers

Returns void

clearHooks

Returns this

ProtectedclearProvidersAndSetDefault

Parameters

Returns Promise<void>

close

Returns Promise<void>

ProtectedgetAssociatedEventEmitters

Parameters

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

getHandlers

Type Parameters

Parameters

Returns EventHandler<ServerProviderEvents | ProviderEvents>[]

getHooks

Returns H[]

ProtectedgetProviderForClient

Parameters

Returns P

getProviderMetadata

Parameters

Returns ProviderMetadata

removeHandler

Type Parameters

Parameters

Returns void

ProtectedsetAwaitableProvider

Parameters

Returns void | Promise<void>

setLogger

Parameters

Returns this

AbstractsetProvider

Parameters

Returns this

AbstractsetProviderAndWait

Parameters

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

`Protected` `Abstract` `Readonly`_apiEmitter

`Protected`_clientEvents

`Protected`_context

`Protected` `Abstract`_defaultProvider

`Protected`_domainScopedContext

`Protected` `Abstract` `Readonly`_domainScopedProviders

`Protected`_hooks

`Protected`_logger

`Protected`_runsOn

`Protected` `Abstract` `Readonly`_statusEnumType

`Protected` `Abstract`_createEventEmitter

`Protected`buildAndCacheEventEmitterForClient

`Protected`clearProvidersAndSetDefault

`Protected`getAssociatedEventEmitters

`Protected`getProviderForClient

`Protected`setAwaitableProvider

`Abstract`setProvider

`Abstract`setProviderAndWait