Interface: IEventEmitter

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

Interface for event emitter

Methods

emit()

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

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

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>

---

off()

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

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

Remove a handler for an event

Type Parameters

Type Parameter	Default type
T	any

Parameters

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

Returns

void

---

on()

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

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

Register a handler for an event

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
event	string | symbol
handler	EventHandler<T>

Returns

void

---

once()

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

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

Register a one-time handler for an event

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
event	string | symbol
handler	EventHandler<T>

Returns

void