basalt / events/src / EventBus
Class: EventBus
Defined in: events/src/index.ts:53
Constructors
Constructor
> new EventBus(): EventBus
Returns
EventBus
Methods
emit()
> emit<T>(event, ...args): Promise<void>
Defined in: events/src/index.ts:91
Emits an event: validates the payload (if there is a schema) and runs the listeners in series by priority. All listeners run even if one of them fails; failures are aggregated into an AggregateError at the end.
Type Parameters
T
T
Parameters
event
BasaltEvent<T>
args
...T extends void ? [] : [T]
Returns
Promise<void>
listenerCount()
> listenerCount(eventName): number
Defined in: events/src/index.ts:114
Parameters
eventName
string
Returns
number
on()
Call Signature
> on<T>(event, handler, options?): () => void
Defined in: events/src/index.ts:63
Subscribes to a typed event or a string pattern with wildcards:
on(OrderCreated, h)— typed payloadon('order.*', h)— one wildcard segmenton('order.**', h)oron('**', h)— any suffix Returns an unsubscribe function.
Type Parameters
T
T
Parameters
event
BasaltEvent<T>
handler
EventHandler<T>
options?
Returns
() => void
Call Signature
> on(pattern, handler, options?): () => void
Defined in: events/src/index.ts:64
Subscribes to a typed event or a string pattern with wildcards:
on(OrderCreated, h)— typed payloadon('order.*', h)— one wildcard segmenton('order.**', h)oron('**', h)— any suffix Returns an unsubscribe function.
Parameters
pattern
string
handler
EventHandler<unknown>
options?
Returns
() => void
once()
> once<T>(event, handler): () => void
Defined in: events/src/index.ts:82
Type Parameters
T
T
Parameters
event
BasaltEvent<T>
handler
EventHandler<T>
Returns
() => void