Interface TypedEventTarget<TEvents>

Decorator for EventTarget allowing to strongly type events and listeners

See

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

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

Type Parameters

TEvents extends TypedEvent<any>
union of dispatched events

Hierarchy (View Summary)

EventTarget
- TypedEventTarget
  - AbstractPlugin
  - Viewer

Index

Methods

addEventListener dispatchEvent removeEventListener

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
Overrides EventTarget.addEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:29

dispatchEvent

dispatchEvent(e: TEvents): 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
Parameters
- e: TEvents
Returns boolean
Overrides EventTarget.dispatchEvent
- Defined in packages/core/src/lib/TypedEventTarget.ts:21

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
Overrides EventTarget.removeEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:41

Interface TypedEventTarget<TEvents>

See

Type Parameters

Hierarchy (View Summary)

Index

Methods

Methods

addEventListener

Type Parameters

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

removeEventListener

Type Parameters

Parameters

Returns void

Settings

On This Page