Class EventDispatcher<EventMap>

Protocol-independent DOM-style event fan-out.

Owners perform event-specific state updates before calling dispatch. Dispatch then invokes the singular handler followed by a snapshot of listeners in insertion order.

Type Parameters

EventMap extends Record<string, unknown>
Maps event names to their listener parameter types.

Index

Constructors

Methods

addEventListener dispatch getHandler removeEventListener setHandler

Constructors

constructor

new EventDispatcher<EventMap extends Record<string, unknown>>(): EventDispatcher<
EventMap,
>
Type Parameters
- EventMap extends Record<string, unknown>
  Maps event names to their listener parameter types.
Returns EventDispatcher<EventMap>

Methods

addEventListener

addEventListener<K extends string | number | symbol>(
event: K,
handler: (params: EventMap[K]) => void,
): void
Add a listener. Listeners run in insertion order after the handler.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- handler: (params: EventMap[K]) => void
Returns void
- Defined in src/events.ts:46

dispatch

dispatch<K extends string | number | symbol>(
event: K,
params: EventMap[K],
): void
Dispatch an event to its singular handler and a listener snapshot. Listener mutations during dispatch take effect on the next dispatch.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- params: EventMap[K]
Returns void
- Defined in src/events.ts:70

getHandler

getHandler<K extends string | number | symbol>(
event: K,
): ((params: EventMap[K]) => void) | undefined
Get the singular handler for an event, if one is set.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
Returns ((params: EventMap[K]) => void) | undefined
- Defined in src/events.ts:38

removeEventListener

removeEventListener<K extends string | number | symbol>(
event: K,
handler: (params: EventMap[K]) => void,
): void
Remove the first matching listener, if present.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- handler: (params: EventMap[K]) => void
Returns void
- Defined in src/events.ts:54

setHandler

setHandler<K extends string | number | symbol>(
event: K,
handler: ((params: EventMap[K]) => void) | undefined,
): void
Set, replace, or clear the singular handler for an event.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- handler: ((params: EventMap[K]) => void) | undefined
Returns void
- Defined in src/events.ts:23