Interface EventDispatcher<Events>

Type-safe event dispatcher.

interface EventDispatcher {
    addEventListener<K>(type, listener): void;
    dispatchEvent(event): boolean;
    removeEventListener<K>(type, listener): void;
}

Type Parameters

Events extends TypedEvent[]

Hierarchy

EventSource<Events>
- EventDispatcher

Implemented by

TypedEventTarget

Index

Methods

addEventListener dispatchEvent removeEventListener

Methods

addEventListener

addEventListener<K>(type, listener): void
Registers an event handler of a specific event type.
Type Parameters
- K extends string
Parameters
- type: K
- listener: TypedEventHandler<Extract<Events[keyof Events], TypedEvent<K>>, unknown>
Returns void
Inherited from EventSource.addEventListener
- Defined in packages/commons/src/event.ts:42

dispatchEvent

dispatchEvent(event): boolean
Dispatches the event to the list of handlers for event.type.
Parameters
- event: Events[keyof Events]
Returns boolean
false if event is cancelled; true otherwise.
- Defined in packages/commons/src/event.ts:36

removeEventListener

removeEventListener<K>(type, listener): void
Removes an event listener.
Type Parameters
- K extends string
Parameters
- type: K
- listener: TypedEventHandler<Extract<Events[keyof Events], TypedEvent<K>>, unknown>
Returns void
Inherited from EventSource.removeEventListener
- Defined in packages/commons/src/event.ts:45

Generated using TypeDoc