@proto-kit/common • Docs

Documentation / @proto-kit/common / EventEmitter

Class: EventEmitter<Events>

Extended by

• EventEmitterProxy
• ReplayingSingleUseEventEmitter

Type Parameters

• Events extends EventsRecord

Constructors

new EventEmitter()

new EventEmitter<Events>(): EventEmitter<Events>

Returns

EventEmitter<Events>

Properties

listeners

protected readonly listeners: ListenersHolder<Events> = {}

Defined in

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

wildcardListeners

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

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: Events[Key]

Returns

void

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

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

Defined in

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

onAll()

onAll(listener): void

Parameters

• listener

Returns

void

Defined in

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