Class TypedEventTarget<Events>

Type-safe EventTarget.

Type Parameters

Events extends TypedEvent[]

Hierarchy

EventTarget
- TypedEventTarget

Implements

EventDispatcher<Events>

Index

Constructors

Methods

addEventListener dispatchEvent removeEventListener

Constructors

constructor

new TypedEventTarget<Events>(): TypedEventTarget<Events>
Type Parameters
- Events extends TypedEvent<string>[]
Returns TypedEventTarget<Events>
Inherited from EventTarget.constructor
- Defined in node_modules/typescript/lib/lib.dom.d.ts:8228

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: null | TypedEventHandler<Extract<Events[keyof Events], TypedEvent<K>>, unknown>
Returns void
Implementation of EventDispatcher.addEventListener
Overrides EventTarget.addEventListener
- Defined in packages/commons/src/event.ts:52

dispatchEvent

dispatchEvent<K>(event): boolean
Dispatches the event to the list of handlers for event.type.
Type Parameters
- K extends string
Parameters
- event: Extract<Events[keyof Events], TypedEvent<K>>
Returns boolean
false if event is cancelled; true otherwise.
Implementation of EventDispatcher.dispatchEvent
Overrides EventTarget.dispatchEvent
- Defined in packages/commons/src/event.ts:64

removeEventListener

removeEventListener<K>(type, listener): void
Removes an event listener.
Type Parameters
- K extends string
Parameters
- type: K
- listener: null | TypedEventHandler<Extract<Events[keyof Events], TypedEvent<K>>, unknown>
Returns void
Implementation of EventDispatcher.removeEventListener
Overrides EventTarget.removeEventListener
- Defined in packages/commons/src/event.ts:58

Generated using TypeDoc