Class OpenFeatureClient

Implements

Client

Constructors

constructor

new OpenFeatureClient(providerAccessor, providerStatusAccessor, emitterAccessor, globalLogger, options): OpenFeatureClient
Parameters
- providerAccessor: (() => Provider)
  - - (): Provider
    - Returns Provider
- providerStatusAccessor: (() => ProviderStatus)
  - - (): ProviderStatus
    - Returns ProviderStatus
- emitterAccessor: (() => InternalEventEmitter)
  - - (): InternalEventEmitter
    - Returns InternalEventEmitter
- globalLogger: (() => Logger)
  - - (): Logger
    - Returns Logger
- options: OpenFeatureClientOptions
Returns OpenFeatureClient
- Defined in packages/client/src/client/open-feature-client.ts:41

Properties

`Private` `Optional` _clientLogger

_clientLogger?: Logger

`Private` _hooks

_hooks: Hook[] = []

`Private` `Readonly` emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

- (): InternalEventEmitter
- Returns InternalEventEmitter

`Private` `Readonly` globalLogger

globalLogger: (() => Logger)

Type declaration

- (): Logger
- Returns Logger

`Private` `Readonly` options

options: OpenFeatureClientOptions

`Private` `Readonly` providerAccessor

providerAccessor: (() => Provider)

Type declaration

- (): Provider
- Returns Provider

`Private` `Readonly` providerStatusAccessor

providerStatusAccessor: (() => ProviderStatus)

Type declaration

- (): ProviderStatus
- Returns ProviderStatus

Accessors

providerStatus

get providerStatus(): ProviderStatus
Returns the status of the associated provider.

Returns ProviderStatus
Implementation of Client.providerStatus
- Defined in packages/client/src/client/open-feature-client.ts:61

Methods

addHandler

addHandler(eventType, handler): void
Adds a handler for the given provider event type. The handlers are called in the order they have been added.
Parameters
- eventType: ProviderEvents
  The provider event type to listen to
- handler: EventHandler<ServerProviderEvents | ProviderEvents>
  The handler to run on occurrence of the event type
Returns void
Implementation of Client.addHandler
- Defined in packages/client/src/client/open-feature-client.ts:65

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)
Implementation of Client.addHooks
- Defined in packages/client/src/client/open-feature-client.ts:96

`Private` afterHooks

afterHooks(hooks, hookContext, evaluationDetails, options): void
Parameters
- hooks: Hook[]
- hookContext: HookContext<FlagValue>
- evaluationDetails: EvaluationDetails<FlagValue>
- options: FlagEvaluationOptions
Returns void
- Defined in packages/client/src/client/open-feature-client.ts:259

`Private` beforeHooks

beforeHooks(hooks, hookContext, options): void
Parameters
- hooks: Hook[]
- hookContext: HookContext<FlagValue>
- options: FlagEvaluationOptions
Returns void
- Defined in packages/client/src/client/open-feature-client.ts:250

clearHooks

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

Returns this
The receiver (this object)
Implementation of Client.clearHooks
- Defined in packages/client/src/client/open-feature-client.ts:105

`Private` errorHooks

errorHooks(hooks, hookContext, err, options): void
Parameters
- hooks: Hook[]
- hookContext: HookContext<FlagValue>
- err: unknown
- options: FlagEvaluationOptions
Returns void
- Defined in packages/client/src/client/open-feature-client.ts:271

`Private` evaluate

evaluate<T>(flagKey, resolver, defaultValue, flagType, options?): EvaluationDetails<T>
Type Parameters
- T extends FlagValue
Parameters
- flagKey: string
- resolver: ((flagKey, defaultValue, context, logger) => ResolutionDetails<T>)
  - - (flagKey, defaultValue, context, logger): ResolutionDetails<T>
    - Parameters
      flagKey: string
      defaultValue: T
      context: EvaluationContext
      logger: Logger
      Returns ResolutionDetails<T>
- defaultValue: T
- flagType: FlagValueType
- options: FlagEvaluationOptions = {}
Returns EvaluationDetails<T>
- Defined in packages/client/src/client/open-feature-client.ts:176

`Private` finallyHooks

finallyHooks(hooks, hookContext, options): void
Parameters
- hooks: Hook[]
- hookContext: HookContext<FlagValue>
- options: FlagEvaluationOptions
Returns void
- Defined in packages/client/src/client/open-feature-client.ts:286

getBooleanDetails

getBooleanDetails(flagKey, defaultValue, options?): EvaluationDetails<boolean>
Performs a flag evaluation that a returns an evaluation details object.
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: boolean
  The value returned if an error occurs
- Optional options: FlagEvaluationOptions
  Additional flag evaluation options
Returns EvaluationDetails<boolean>
Flag evaluation details response
Implementation of Client.getBooleanDetails
- Defined in packages/client/src/client/open-feature-client.ts:114

getBooleanValue

getBooleanValue(flagKey, defaultValue, options?): boolean
Performs a flag evaluation that returns a boolean.
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: boolean
  The value returned if an error occurs
- Optional options: FlagEvaluationOptions
  Additional flag evaluation options
Returns boolean
Flag evaluation response
Implementation of Client.getBooleanValue
- Defined in packages/client/src/client/open-feature-client.ts:110

getHandlers

getHandlers(eventType): EventHandler<ServerProviderEvents | ProviderEvents>[]
Gets the current handlers for the given provider event type.
Parameters
- eventType: ProviderEvents
  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 Client.getHandlers
- Defined in packages/client/src/client/open-feature-client.ts:87

getHooks

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

Returns Hook[]
A list of the client hooks
Implementation of Client.getHooks
- Defined in packages/client/src/client/open-feature-client.ts:101

getNumberDetails

getNumberDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>
Performs a flag evaluation that a returns an evaluation details object.
Type Parameters
- T extends number = number
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: T
  The value returned if an error occurs
- Optional options: FlagEvaluationOptions
  Additional flag evaluation options
Returns EvaluationDetails<T>
Flag evaluation details response
Implementation of Client.getNumberDetails
- Defined in packages/client/src/client/open-feature-client.ts:145

getNumberValue

getNumberValue<T>(flagKey, defaultValue, options?): T
Performs a flag evaluation that returns a number.
Type Parameters
- T extends number = number
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: T
  The value returned if an error occurs
- Optional options: FlagEvaluationOptions
  Additional flag evaluation options
Returns T
Flag evaluation response
Implementation of Client.getNumberValue
- Defined in packages/client/src/client/open-feature-client.ts:141

getObjectDetails

getObjectDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>
Performs a flag evaluation that a returns an evaluation details object.
Type Parameters
- T extends JsonValue = JsonValue
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: T
  The value returned if an error occurs
- Optional options: FlagEvaluationOptions
  Additional flag evaluation options
Returns EvaluationDetails<T>
Flag evaluation details response
Implementation of Client.getObjectDetails
- Defined in packages/client/src/client/open-feature-client.ts:168

getObjectValue

getObjectValue<T>(flagKey, defaultValue, options?): T
Performs a flag evaluation that returns an object.
Type Parameters
- T extends JsonValue = JsonValue
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: T
  The value returned if an error occurs
- Optional options: FlagEvaluationOptions
  Additional flag evaluation options
Returns T
Flag evaluation response
Implementation of Client.getObjectValue
- Defined in packages/client/src/client/open-feature-client.ts:160

getStringDetails

getStringDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>
Performs a flag evaluation that a returns an evaluation details object.
Type Parameters
- T extends string = string
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: T
  The value returned if an error occurs
- Optional options: FlagEvaluationOptions
  Additional flag evaluation options
Returns EvaluationDetails<T>
Flag evaluation details response
Implementation of Client.getStringDetails
- Defined in packages/client/src/client/open-feature-client.ts:126

getStringValue

getStringValue<T>(flagKey, defaultValue, options?): T
Performs a flag evaluation that returns a string.
Type Parameters
- T extends string = string
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: T
  The value returned if an error occurs
- Optional options: FlagEvaluationOptions
  Additional flag evaluation options
Returns T
Flag evaluation response
Implementation of Client.getStringValue
- Defined in packages/client/src/client/open-feature-client.ts:122

removeHandler

removeHandler(notificationType, handler): void
Removes a handler for the given provider event type.
Parameters
- notificationType: ProviderEvents
  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 Client.removeHandler
- Defined in packages/client/src/client/open-feature-client.ts:83

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 Client.setLogger
- Defined in packages/client/src/client/open-feature-client.ts:91

Class OpenFeatureClient

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Provider

Returns ProviderStatus

Returns InternalEventEmitter

Returns Logger

Returns OpenFeatureClient

Properties

Private Optional _clientLogger

Private _hooks

Private Readonly emitterAccessor

Type declaration

Returns InternalEventEmitter

Private Readonly globalLogger

Type declaration

Returns Logger

Private Readonly options

Private Readonly providerAccessor

Type declaration

Returns Provider

Private Readonly providerStatusAccessor

Type declaration

Returns ProviderStatus

Accessors

Private _logger

Returns Logger

Private _provider

Returns Provider

metadata

Returns ClientMetadata

providerStatus

Returns ProviderStatus

Methods

addHandler

Parameters

Returns void

addHooks

Parameters

Returns this

Private afterHooks

Parameters

Returns void

Private beforeHooks

Parameters

Returns void

clearHooks

Returns this

Private errorHooks

Parameters

Returns void

Private evaluate

Type Parameters

Parameters

Parameters

Returns ResolutionDetails<T>

Returns EvaluationDetails<T>

Private finallyHooks

Parameters

Returns void

getBooleanDetails

Parameters

Returns EvaluationDetails<boolean>

getBooleanValue

Parameters

Returns boolean

getHandlers

Parameters

Returns EventHandler<ServerProviderEvents | ProviderEvents>[]

getHooks

Returns Hook[]

getNumberDetails

Type Parameters

`Private` `Optional` _clientLogger

`Private` _hooks

`Private` `Readonly` emitterAccessor

`Private` `Readonly` globalLogger

`Private` `Readonly` options

`Private` `Readonly` providerAccessor

`Private` `Readonly` providerStatusAccessor

`Private` _logger

`Private` _provider

`Private` afterHooks

`Private` beforeHooks

`Private` errorHooks

`Private` evaluate

`Private` finallyHooks