@proto-kit/common • Docs

Documentation / @proto-kit/common / EventEmitterProxy

Class: EventEmitterProxy<Modules>

Extends

• EventEmitter<CastToEventsRecord<FlattenedContainerEvents<Modules>>>

Type Parameters

• Modules extends ModulesRecord

Constructors

new EventEmitterProxy()

new EventEmitterProxy<Modules>(container): EventEmitterProxy<Modules>

Parameters

• container: ModuleContainer<Modules, any>

Returns

EventEmitterProxy<Modules>

Overrides

EventEmitter.constructor

Defined in

packages/common/src/events/EventEmitterProxy.ts:45

Properties

listeners

protected readonly listeners: ListenersHolder<CastToEventsRecord<UnionToIntersection<ContainerEvents<Modules>[StringKeyOf<Modules>]>>> = {}

Inherited from

EventEmitter.listeners

Defined in

packages/common/src/events/EventEmitter.ts:8

wildcardListeners

protected readonly wildcardListeners: (event, args) => void[] = []

Inherited from

EventEmitter.wildcardListeners

Defined in

packages/common/src/events/EventEmitter.ts:10

Methods

emit()

emit<Key>(event, …parameters): void

Type Parameters

• Key extends string | number | symbol

Parameters

• event: Key

• …parameters: CastToEventsRecord<UnionToIntersection<ContainerEvents<Modules>[StringKeyOf<Modules>]>>[Key]

Returns

void

Inherited from

EventEmitter.emit

Defined in

packages/common/src/events/EventEmitter.ts:15

off()

off<Key>(event, listener): void

Primitive .off() with identity comparison for now. Could be replaced by returning an id in .on() and using that.

Type Parameters

• Key extends string | number | symbol

Parameters

• event: Key

• listener

Returns

void

Inherited from

EventEmitter.off

Defined in

packages/common/src/events/EventEmitter.ts:45

on()

on<Key>(event, listener): void

Type Parameters

• Key extends string | number | symbol

Parameters

• event: Key

• listener

Returns

void

Inherited from

EventEmitter.on

Defined in

packages/common/src/events/EventEmitter.ts:34

onAll()

onAll(listener): void

Parameters

• listener

Returns

void

Inherited from

EventEmitter.onAll

Defined in

packages/common/src/events/EventEmitter.ts:30