Skip to main content

Class: EventBus<TEvents>

Defined in: packages/plugin-sdk/src/events.ts:11

Type Parameters​

TEvents​

TEvents extends EventMap

Constructors​

Constructor​

new EventBus<TEvents>(): EventBus<TEvents>

Returns​

EventBus<TEvents>

Methods​

clear()​

clear(): void

Defined in: packages/plugin-sdk/src/events.ts:45

Remove all subscriptions (used on full teardown).

Returns​

void

emit()​

emit<K>(event, payload): void

Defined in: packages/plugin-sdk/src/events.ts:31

Emit an event to all current subscribers.

Type Parameters​

K​

K extends string | number | symbol

Parameters​

event​

K

payload​

TEvents[K]

Returns​

void

off()​

off<K>(event, handler): void

Defined in: packages/plugin-sdk/src/events.ts:26

Unsubscribe a handler.

Type Parameters​

K​

K extends string | number | symbol

Parameters​

event​

K

handler​

EventHandler<TEvents[K]>

Returns​

void

on()​

on<K>(event, handler): () => void

Defined in: packages/plugin-sdk/src/events.ts:15

Subscribe to an event. Returns an unsubscribe function.

Type Parameters​

K​

K extends string | number | symbol

Parameters​

event​

K

handler​

EventHandler<TEvents[K]>

Returns​

() => void