Interface EventSource<Events>

Type-safe event source.

interface EventSource {
addEventListener<K>(type, listener): void;
removeEventListener<K>(type, listener): void;
}

Type Parameters

Events extends TypedEvent[]

Hierarchy

EventSource
- EventDispatcher

Index

Methods

addEventListener 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
- Defined in packages/commons/src/event.ts:42

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
- Defined in packages/commons/src/event.ts:45

Generated using TypeDoc