Interface TypedEventTarget<K, R>

Interface restricting the events emitted by an EventTarget to a certain kind of Event, discriminated by their type properties.

interface TypedEventTarget<K extends string, R extends Record<K, Event> = never> {
    addEventListener<
        EvtType extends string,
        T extends TypedEventTarget<K, R>,
    >(
        type: EvtType,
        callback: (this: T, evt: R[EvtType]) => void,
        options?: boolean | AddEventListenerOptions,
    ): void;
    dispatchEvent(event: R[K]): boolean;
    removeEventListener<
        EvtType extends string,
        T extends TypedEventTarget<K, R>,
    >(
        type: EvtType,
        callback: (this: T, evt: R[EvtType]) => void,
        options?: boolean | AddEventListenerOptions,
    ): void;
}

Type Parameters

K extends string
A union of string literal types representing the allowed event names; only required to allow R to hold a subset of string keys and avoid index signature errors
R extends Record<K, Event> = never
An object type matching event names in K to their corresponding Event subclasses.

Hierarchy

EventTarget
- TypedEventTarget

Index

Methods

addEventListener dispatchEvent removeEventListener

Methods

addEventListener

addEventListener<EvtType extends string, T extends TypedEventTarget<K, R>>(
    type: EvtType,
    callback: (this: T, evt: R[EvtType]) => 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
- EvtType extends string
- T extends TypedEventTarget<K, R>
Parameters
- type: EvtType
- callback: (this: T, evt: R[EvtType]) => void
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in src/@types/typed-event-target.ts:12

dispatchEvent

dispatchEvent(event: R[K]): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

MDN Reference
Parameters
- event: R[K]
Returns boolean
Overrides EventTarget.dispatchEvent
- Defined in src/@types/typed-event-target.ts:18

removeEventListener

removeEventListener<EvtType extends string, T extends TypedEventTarget<K, R>>(
    type: EvtType,
    callback: (this: T, evt: R[EvtType]) => void,
    options?: boolean | AddEventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

MDN Reference
Type Parameters
- EvtType extends string
- T extends TypedEventTarget<K, R>
Parameters
- type: EvtType
- callback: (this: T, evt: R[EvtType]) => void
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in src/@types/typed-event-target.ts:19