Class WidgetBus<Events>

A tiny typed event bus. Handlers run in registration order; one that throws does not stop the others, because a host's listener failing must not take the shell's own bookkeeping with it.

Type Parameters

Events extends Record<string, unknown> = Record<string, unknown>

Index

Constructors

Methods

clear emit off on

Constructors

constructor

new WidgetBus<Events extends Record<string, unknown> = Record<string, unknown>>(): WidgetBus<
Events,
>
Type Parameters
- Events extends Record<string, unknown> = Record<string, unknown>
Returns WidgetBus<Events>

Methods

clear

clear(): void
Returns void
- Defined in src/widget/context.ts:186

emit

emit<K extends string>(event: K, payload: Events[K]): void
Type Parameters
- K extends string
Parameters
- event: K
- payload: Events[K]
Returns void
- Defined in src/widget/context.ts:176

off

off<K extends string>(event: K, handler?: BusHandler<Events[K]>): void
Type Parameters
- K extends string
Parameters
- event: K
- Optionalhandler: BusHandler<Events[K]>
Returns void
- Defined in src/widget/context.ts:171

on

on<K extends string>(event: K, handler: BusHandler<Events[K]>): () => void
Type Parameters
- K extends string
Parameters
- event: K
- handler: BusHandler<Events[K]>
Returns () => void
- Defined in src/widget/context.ts:164