Class TypedEventTarget<TEventMap>

Type Parameters

TEventMap extends Record<string, Event>

Hierarchy (View Summary)

EventTarget
- TypedEventTarget
  - YatlTableController

Index

Constructors

Methods

addEventListener dispatchEvent removeEventListener

Constructors

constructor

new TypedEventTarget<TEventMap extends Record<string, Event>>(): TypedEventTarget
Type Parameters
- TEventMap extends Record<string, Event>
Returns TypedEventTarget
Inherited from EventTarget.constructor
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11586

Methods

addEventListener

addEventListener<K extends string | number | symbol>(
    type: K,
    listener: (this: TEventMap, ev: TEventMap[K]) => void,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- listener: (this: TEventMap, ev: TEventMap[K]) => void
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in packages/yatl/src/utils/typed-event-target.ts:4
addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in packages/yatl/src/utils/typed-event-target.ts:10

dispatchEvent

dispatchEvent<K extends string | number | symbol>(event: TEventMap[K]): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Type Parameters
- K extends string | number | symbol
Parameters
- event: TEventMap[K]
Returns boolean
Overrides EventTarget.dispatchEvent
- Defined in packages/yatl/src/utils/typed-event-target.ts:42

removeEventListener

removeEventListener<K extends string | number | symbol>(
    type: K,
    listener: EventListenerOrEventListenerObject | null,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- listener: EventListenerOrEventListenerObject | null
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in packages/yatl/src/utils/typed-event-target.ts:28