Class OpenFeatureEventEmitter

The OpenFeatureEventEmitter can be used by provider developers to emit events at various parts of the provider lifecycle.

NOTE: Ready and error events are automatically emitted by the SDK based on the result of the initialize method.

Hierarchy (view full)

GenericEventEmitter<ProviderEmittableEvents>
- OpenFeatureEventEmitter

Index

Constructors

Properties

Accessors

Methods

addHandler emit getHandlers removeAllHandlers removeHandler setLogger

Constructors

constructor

new OpenFeatureEventEmitter(): OpenFeatureEventEmitter
Returns OpenFeatureEventEmitter
Overrides GenericEventEmitter.constructor
- Defined in packages/client/src/events/open-feature-event-emitter.ts:15

Properties

`Protected` `Readonly` eventEmitter

eventEmitter: EventEmitter<string | symbol, any> = ...

Accessors

`Protected` _logger

get _logger(): undefined | Logger
Returns undefined | Logger
Inherited from GenericEventEmitter._logger
- Defined in packages/shared/src/events/generic-event-emitter.ts:85

Methods

addHandler

addHandler(eventType, handler): void
Parameters
- eventType: AnyProviderEvent
- handler: EventHandler<ServerProviderEvents | ProviderEvents>
Returns void
Inherited from GenericEventEmitter.addHandler
- Defined in packages/shared/src/events/generic-event-emitter.ts:35

emit

emit(eventType, context?): void
Parameters
- eventType: ProviderEmittableEvents
- Optional context: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>
Returns void
Inherited from GenericEventEmitter.emit
- Defined in packages/shared/src/events/generic-event-emitter.ts:31

getHandlers

getHandlers(eventType): EventHandler<ServerProviderEvents | ProviderEvents>[]
Parameters
- eventType: AnyProviderEvent
Returns EventHandler<ServerProviderEvents | ProviderEvents>[]
Inherited from GenericEventEmitter.getHandlers
- Defined in packages/shared/src/events/generic-event-emitter.ts:76

removeAllHandlers

removeAllHandlers(eventType?): void
Parameters
- Optional eventType: AnyProviderEvent
Returns void
Inherited from GenericEventEmitter.removeAllHandlers
- Defined in packages/shared/src/events/generic-event-emitter.ts:67

removeHandler

removeHandler(eventType, handler): void
Parameters
- eventType: AnyProviderEvent
- handler: EventHandler<ServerProviderEvents | ProviderEvents>
Returns void
Inherited from GenericEventEmitter.removeHandler
- Defined in packages/shared/src/events/generic-event-emitter.ts:55

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)
Inherited from GenericEventEmitter.setLogger
- Defined in packages/shared/src/events/generic-event-emitter.ts:80

Generated using TypeDoc