Class GenericEventEmitter<E, AdditionalContext>`Abstract`

The GenericEventEmitter should only be used within the SDK. It supports additional properties that can be included in the event details.

Type Parameters

E extends AnyProviderEvent
AdditionalContext extends Record<string, unknown> = Record<string, unknown>

Hierarchy (view full)

GenericEventEmitter
- OpenFeatureEventEmitter

Implements

Index

Constructors

Properties

Accessors

Methods

addHandler emit getHandlers removeAllHandlers removeHandler setLogger

Constructors

constructor

new GenericEventEmitter<E, AdditionalContext>(globalLogger?): GenericEventEmitter<E, AdditionalContext>
Type Parameters
- E extends AnyProviderEvent
- AdditionalContext extends Record<string, unknown> = Record<string, unknown>
Parameters
- OptionalglobalLogger: (() => Logger)
  - - (): Logger
    - Returns Logger
Returns GenericEventEmitter<E, AdditionalContext>
- Defined in packages/shared/src/events/generic-event-emitter.ts:30

Properties

`Protected` `Abstract` `Readonly`eventEmitter

eventEmitter: PlatformEventEmitter

Accessors

`Protected`_logger

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

Methods

addHandler

addHandler(eventType, handler): void
Parameters
- eventType: AnyProviderEvent
- handler: EventHandler<ProviderEvents | ClientProviderEvents>
Returns void
Implementation of ProviderEventEmitter.addHandler
- Defined in packages/shared/src/events/generic-event-emitter.ts:37

emit

emit(eventType, context?): void
Parameters
- eventType: E
- Optionalcontext: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>
Returns void
Implementation of ProviderEventEmitter.emit
- Defined in packages/shared/src/events/generic-event-emitter.ts:33

getHandlers

getHandlers(eventType): EventHandler<ProviderEvents | ClientProviderEvents>[]
Parameters
- eventType: AnyProviderEvent
Returns EventHandler<ProviderEvents | ClientProviderEvents>[]
Implementation of ProviderEventEmitter.getHandlers
- Defined in packages/shared/src/events/generic-event-emitter.ts:78

removeAllHandlers

removeAllHandlers(eventType?): void
Parameters
- OptionaleventType: AnyProviderEvent
Returns void
Implementation of ProviderEventEmitter.removeAllHandlers
- Defined in packages/shared/src/events/generic-event-emitter.ts:69

removeHandler

removeHandler(eventType, handler): void
Parameters
- eventType: AnyProviderEvent
- handler: EventHandler<ProviderEvents | ClientProviderEvents>
Returns void
Implementation of ProviderEventEmitter.removeHandler
- Defined in packages/shared/src/events/generic-event-emitter.ts:57

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/events/generic-event-emitter.ts:82