Class EventBus<Events>

Typed pub/sub used by Gallery and every plugin (ctx.on). Plugin subscriptions are unsubscribed automatically on destroy by the caller that owns the PluginContext, not by this class.

Type Parameters

Events extends EventMap

Index

Constructors

Methods

on off emit clear

Constructors

constructor

new EventBus<Events extends EventMap>(): EventBus<Events>
Type Parameters
- Events extends EventMap
Returns EventBus<Events>

Methods

on

on<K extends string | number | symbol>(
event: K,
fn: Listener<Events[K]>,
): Unsubscribe
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- fn: Listener<Events[K]>
Returns Unsubscribe
- Defined in core/EventBus.ts:15

off

off<K extends string | number | symbol>(event: K, fn: Listener<Events[K]>): void
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- fn: Listener<Events[K]>
Returns void
- Defined in core/EventBus.ts:25

emit

emit<K extends string | number | symbol>(event: K, detail: Events[K]): void
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- detail: Events[K]
Returns void
- Defined in core/EventBus.ts:29

clear

clear(): void
Returns void
- Defined in core/EventBus.ts:35