Skip to content

Class: Emitter<Events> ​

A typed event emitter over a private EventTarget. Events maps each event name to its listener signature, so the name decides what a listener receives and what emit() must be given. A throwing listener doesn't affect the others: EventTarget reports it to the global error handler.

Extended by ​

Type Parameters ​

Events ​

Events extends { [K in keyof Events]: (args: any[]) => void }

Constructors ​

Constructor ​

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

Returns ​

Emitter<Events>

Methods ​

emit() ​

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

Calls every listener of event with args. Allocates nothing when there are none.

Type Parameters ​

K ​

K extends string

Parameters ​

event ​

K

args ​

...Parameters<Events[K]>

Returns ​

void


off() ​

off<K>(event, listener): void

Removes listener, the same function given to on(), from event.

Type Parameters ​

K ​

K extends string

Parameters ​

event ​

K

listener ​

Events[K]

Returns ​

void


on() ​

on<K>(event, listener): void

Adds listener for event. Adding the same function twice has no effect.

Type Parameters ​

K ​

K extends string

Parameters ​

event ​

K

listener ​

Events[K]

Returns ​

void