Class: EventEmitter

Defined in: packages/core/src/events/event-emitter.ts:11

Event emitter for dispatching and handling events

Implements

• IEventEmitter

Constructors

Constructor

new EventEmitter(): EventEmitter;

Returns

EventEmitter

Methods

emit()

emit<T>(event, payload): Promise<void>;

Defined in: packages/core/src/events/event-emitter.ts:64

Emit an event with a payload

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
event	string | symbol
payload	T

Returns

Promise<void>

Implementation of

IEventEmitter.emit

---

off()

off<T>(event, handler?): void;

Defined in: packages/core/src/events/event-emitter.ts:35

Remove an event handler

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
event	string | symbol
handler?	EventHandler<T>

Returns

void

Implementation of

IEventEmitter.off

---

on()

on<T>(event, handler): void;

Defined in: packages/core/src/events/event-emitter.ts:21

Register an event handler

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
event	string | symbol
handler	EventHandler<T>

Returns

void

Implementation of

IEventEmitter.on

---

once()

once<T>(event, handler): void;

Defined in: packages/core/src/events/event-emitter.ts:28

Register a one-time event handler

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
event	string | symbol
handler	EventHandler<T>

Returns

void

Implementation of

IEventEmitter.once

---

removeAllListeners()

removeAllListeners(event?): void;

Defined in: packages/core/src/events/event-emitter.ts:108

Remove all listeners, or all listeners for a specific event

Parameters

Parameter	Type
event?	string | symbol

Returns

void