Class G3tEventBus

Index

Constructors

Accessors

Methods

emit off on once

Constructors

constructor

new G3tEventBus(): G3tEventBus
Returns G3tEventBus

Accessors

listenerCount

get listenerCount(): number
Number of active subscriptions (for debugging).

Returns number
- Defined in core/src/event-bus/event-bus.ts:113

Methods

emit

emit<K extends keyof G3tEvents>(event: K, data: G3tEvents[K]): void
Emit an event to all subscribers.
Type Parameters
- K extends keyof G3tEvents
Parameters
- event: K
- data: G3tEvents[K]
Returns void
- Defined in core/src/event-bus/event-bus.ts:87

off

off(event?: keyof G3tEvents): void
Remove all handlers for an event (or all events).
Parameters
- Optionalevent: keyof G3tEvents
Returns void
- Defined in core/src/event-bus/event-bus.ts:102

on

on<K extends keyof G3tEvents>(
event: K,
handler: EventHandler<G3tEvents[K]>,
): () => void
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- K extends keyof G3tEvents
Parameters
- event: K
- handler: EventHandler<G3tEvents[K]>
Returns () => void
- Defined in core/src/event-bus/event-bus.ts:54

once

once<K extends keyof G3tEvents>(
event: K,
handler: EventHandler<G3tEvents[K]>,
): () => void
Subscribe to an event for a single firing.
Type Parameters
- K extends keyof G3tEvents
Parameters
- event: K
- handler: EventHandler<G3tEvents[K]>
Returns () => void
- Defined in core/src/event-bus/event-bus.ts:73