Skip to content

Class: EventEmitter<Events> ​

Defined in: EventEmitter.ts:10

Extended by ​

Type Parameters ​

Events ​

Events extends object = Record<never, never>

Constructors ​

Constructor ​

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

Defined in: EventEmitter.ts:13

Returns ​

EventEmitter<Events>

Methods ​

on() ​

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

Defined in: EventEmitter.ts:18

Type Parameters ​

K ​

K extends string

Parameters ​

event ​

K

listener ​

TypedEventListener<Events[K]>

Returns ​

UnsubscribeFn


once() ​

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

Defined in: EventEmitter.ts:30

Type Parameters ​

K ​

K extends string

Parameters ​

event ​

K

listener ​

TypedEventListener<Events[K]>

Returns ​

UnsubscribeFn


emit() ​

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

Defined in: EventEmitter.ts:41

Type Parameters ​

K ​

K extends string

Parameters ​

event ​

K

args ​

...EventPayloadArgs<Events[K]>

Returns ​

void


removeListener() ​

ts
removeListener<K>(event, listenerToRemove): void;

Defined in: EventEmitter.ts:60

Type Parameters ​

K ​

K extends string

Parameters ​

event ​

K

listenerToRemove ​

TypedEventListener<Events[K]>

Returns ​

void


removeAllListeners() ​

ts
removeAllListeners(event?): void;

Defined in: EventEmitter.ts:75

Parameters ​

event? ​

Extract<keyof Events, string>

Returns ​

void


off() ​

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

Defined in: EventEmitter.ts:84

Type Parameters ​

K ​

K extends string

Parameters ​

event ​

K

listener ​

TypedEventListener<Events[K]>

Returns ​

void

Released under the MIT License.