EventEmitter
Defined in: core/src/utils/utils.eventemitter.ts:14
A typed event emitter where T maps event names to their listener
signatures, giving on/emit fully typed arguments per event.
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
T extends Record<string, (…args) => void | Promise<void>> |
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new EventEmitter<T>(): EventEmitter<T>;Returns
Section titled “Returns”EventEmitter<T>
Methods
Section titled “Methods”emit()
Section titled “emit()”emit<K>(event, ...args): void;Defined in: core/src/utils/utils.eventemitter.ts:62
Invokes all listeners for event synchronously, without awaiting async listeners.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
event |
K |
…args |
Parameters<T[K]> |
Returns
Section titled “Returns”void
emitAsync()
Section titled “emitAsync()”emitAsync<K>(event, ...args): Promise<void>;Defined in: core/src/utils/utils.eventemitter.ts:73
Invokes all listeners for event and awaits them concurrently via Promise.all.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
event |
K |
…args |
Parameters<T[K]> |
Returns
Section titled “Returns”Promise<void>
on<K>( event, callback, options?): () => void;Defined in: core/src/utils/utils.eventemitter.ts:21
Registers callback for event. Returns an unsubscribe function; passing
options.abortSignal also removes the listener when that signal aborts.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
event |
K |
callback |
EventListener<Parameters<T[K]>> |
options |
OnOptions |
Returns
Section titled “Returns”() => void
once()
Section titled “once()”once<K>( event, callback, options?): () => void;Defined in: core/src/utils/utils.eventemitter.ts:45
Like on, but the listener is removed after firing once.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
event |
K |
callback |
EventListener<Parameters<T[K]>> |
options |
OnOptions |
Returns
Section titled “Returns”() => void