Skip to content

Class: Emitter<Events> ​

Extended by ​

Type Parameters ​

Type Parameter
Events extends Record<string, unknown[]>

Constructors ​

Constructor ​

ts
new Emitter<Events>(): Emitter<Events>;

Returns ​

Emitter<Events>

Methods ​

emit() ​

ts
emit<K>(event, ...args): void;

A throwing listener must not stop the others, and must not fail the transition that emitted the event: an exception in a host's onError handler would otherwise tear down the call it was reporting on.

Type Parameters ​

Type Parameter
K extends string | number | symbol

Parameters ​

ParameterType
eventK
...argsEvents[K]

Returns ​

void


listenerCount() ​

ts
listenerCount(event): number;

Parameters ​

ParameterType
eventkeyof Events

Returns ​

number


off() ​

ts
off<K>(event, listener): void;

Type Parameters ​

Type Parameter
K extends string | number | symbol

Parameters ​

ParameterType
eventK
listenerListener<Events[K]>

Returns ​

void


on() ​

ts
on<K>(event, listener): () => void;

Type Parameters ​

Type Parameter
K extends string | number | symbol

Parameters ​

ParameterType
eventK
listenerListener<Events[K]>

Returns ​

() => void


once() ​

ts
once<K>(event, listener): () => void;

Type Parameters ​

Type Parameter
K extends string | number | symbol

Parameters ​

ParameterType
eventK
listenerListener<Events[K]>

Returns ​

() => void


removeAllListeners() ​

ts
removeAllListeners(): void;

Returns ​

void

Talkline documentation