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)

EventTarget
- TypedEventTarget
  - AbstractPlugin
  - Viewer

Index

Constructors

Methods

addEventListener dispatchEvent removeEventListener

Constructors

constructor

new TypedEventTarget<TEvents extends TypedEvent<any>>(): TypedEventTarget
Type Parameters
- TEvents extends TypedEvent<any>
Returns TypedEventTarget
Inherited from EventTarget.constructor
- Defined in node_modules/typescript/lib/lib.dom.d.ts:8893

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
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
- 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