EventBus
Defined in: EventBus.ts:25
Typed publish/subscribe event bus.
Type Parameters
Section titled “Type Parameters”E = EventMap
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new EventBus<
E>():EventBus<E>
Returns
Section titled “Returns”EventBus<E>
Methods
Section titled “Methods”clear()
Section titled “clear()”clear(
event?):void
Defined in: EventBus.ts:66
Remove all handlers for an event, or all handlers if no event specified.
Parameters
Section titled “Parameters”event?
Section titled “event?”keyof E
Returns
Section titled “Returns”void
emit()
Section titled “emit()”emit<
K>(event,data):void
Defined in: EventBus.ts:55
Emit an event. Handlers are called synchronously in registration order.
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”K
E[K]
Returns
Section titled “Returns”void
on<
K>(event,handler): () =>void
Defined in: EventBus.ts:29
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”K
handler
Section titled “handler”(data) => void
Returns
Section titled “Returns”() => void
once()
Section titled “once()”once<
K>(event,handler): () =>void
Defined in: EventBus.ts:46
Subscribe to an event, auto-unsubscribe after first emission.
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”K
handler
Section titled “handler”(data) => void
Returns
Section titled “Returns”() => void