Class TypedEventTarget<TEvents>

Decorator for EventTarget allowing to strongly type events and listeners

See

https://rjzaworski.com/2021/06/event-target-with-typescript

Type Parameters

  • TEvents extends TypedEvent<any>

    union of dispatched events

Hierarchy (View Summary)

Constructors

constructor

Methods

addEventListener dispatchEvent removeEventListener

Constructors

constructor

Methods

addEventListener

  • addEventListener<T extends string, E extends TypedEvent<any> & { type: T }>(
        type: T,
        callback: EventListenerObject | (e: E) => void,
        options?: boolean | AddEventListenerOptions,
    ): void

  • Type Parameters

    • T extends string

      the name of event

    • E extends TypedEvent<any> & { type: T }

      the class of the event

    Parameters

    • type: T
    • callback: EventListenerObject | (e: E) => void
    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

dispatchEvent

  • dispatchEvent(e: TEvents): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

removeEventListener

  • removeEventListener<T extends string, E extends TypedEvent<any> & { type: T }>(
        type: TEvents["type"],
        callback: EventListenerObject | (e: E) => void,
        options?: boolean | EventListenerOptions,
    ): void

  • Type Parameters

    • T extends string

      the name of event

    • E extends TypedEvent<any> & { type: T }

      the class of the event

    Parameters

    • type: TEvents["type"]
    • callback: EventListenerObject | (e: E) => void
    • Optionaloptions: boolean | EventListenerOptions

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods