Class EventBus<T>

A typed event bus for decoupled communication between components.

Each handler in a given event is wrapped in try/catch so that one failing handler does not prevent the remaining handlers from running.

Example

interface MyEvents {
  save: { id: number };
  quit: void;
}
const bus = new EventBus<MyEvents>();
bus.on('save', ({ id }) => console.log(id));
bus.emit('save', { id: 1 });

Type Parameters

T extends EventMap
Event map type mapping event names to their payload types.

Index

Constructors

constructor

Methods

clear clearEvent emit off on subscriberCount

Constructors

constructor

new EventBus<T extends EventMap>(): EventBus<T>
Type Parameters
- T extends EventMap
  Event map type mapping event names to their payload types.
Returns EventBus<T>

Methods

clear

clear(): void
Remove all listeners for every event.

Returns void
- Defined in EventBus.ts:90

clearEvent

clearEvent<K extends string>(event: K): void
Remove all listeners for a single event type.
Type Parameters
- K extends string
Parameters
- event: K
  The event name to clear.
Returns void
- Defined in EventBus.ts:99

emit

emit<K extends string>(event: K, payload: T[K]): void
Emit an event with a payload.

Each registered listener is called inside its own try/catch so that an error in one handler does not prevent other handlers from running. Errors are logged to console.error with an [ink-cartridge] prefix.
Type Parameters
- K extends string
Parameters
- event: K
  The event name to emit.
- payload: T[K]
  The payload to pass to each listener.
Returns void
- Defined in EventBus.ts:49

off

off<K extends string>(event: K, listener?: Listener<T[K]>): void
Unsubscribe from an event.

If no listener is provided, all listeners for the event are removed.
Type Parameters
- K extends string
Parameters
- event: K
  The event name.
- Optionallistener: Listener<T[K]>
  Optional specific listener to remove.
Returns void
- Defined in EventBus.ts:72

on

on<K extends string>(event: K, listener: Listener<T[K]>): Unsubscribe
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- K extends string
Parameters
- event: K
  The event name to subscribe to.
- listener: Listener<T[K]>
  The callback to invoke when the event is emitted.
Returns Unsubscribe
A function that unsubscribes this listener when called.
- Defined in EventBus.ts:31

subscriberCount

subscriberCount<K extends string>(event: K): number
Get the number of subscribers for an event. Useful for debugging and testing.
Type Parameters
- K extends string
Parameters
- event: K
  The event name.
Returns number
The number of registered listeners.
- Defined in EventBus.ts:109

Class EventBus<T>

Example

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Returns EventBus<T>

Methods

clear

Returns void

clearEvent

Type Parameters

Parameters

Returns void

emit

Type Parameters

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns Unsubscribe

subscriberCount

Type Parameters

Parameters

Returns number

Settings

On This Page