Skip to main content

Class: EventEmitter

Constructors

constructor

new EventEmitter()

Properties

listeners

Private Readonly listeners: Map<string, Set<EventListener<any>>>

Defined in

event/EventEmitter.ts:7


allListeners

Private Readonly allListeners: Set<AllEventsListener<any>>

Defined in

event/EventEmitter.ts:8

Methods

on

on(event, listener): void

Add an event handler for a specific event

Parameters

NameTypeDescription
event"*"The event name
listenerAllEventsListener<any>A event handler function

Returns

void

Defined in

event/EventEmitter.ts:15

on(event, listener): void

Parameters

NameType
eventstring
listenerEventListener<any>

Returns

void

Defined in

event/EventEmitter.ts:16


off

off(event, listener?): void

Remove an event handler of a specific event name or remove all event handlers for a specific event.

Parameters

NameTypeDescription
event"*"The event name where a specific or all handlers should be removed
listener?AllEventsListener<any>An optional event handler function. If specified only this specific handler will be removed and otherwise all handlers are removed.

Returns

void

Defined in

event/EventEmitter.ts:38

off(event, listener?): void

Parameters

NameType
eventstring
listener?EventListener<any>

Returns

void

Defined in

event/EventEmitter.ts:39


emit

emit<T>(event, data): void

Use this function to emit an event. All handlers that are listening for this event will be triggered with the data parameter.

Type parameters

NameType
Tany

Parameters

NameTypeDescription
eventstringThe event name that should be triggered
dataTArbitrary data that will be passed to the event handler callback functions

Returns

void

Defined in

event/EventEmitter.ts:69