Class TypedEventTarget<E>

Event target for events of type E.

Type Parameters

E extends TypedEvent<string, unknown>
Supported events type.

Index

Constructors

Methods

addEventListener dispatchEvent removeEventListener

Constructors

constructor

new TypedEventTarget<E extends TypedEvent<string, unknown>>(): TypedEventTarget<
E,
>
Type Parameters
- E extends TypedEvent<string, unknown>
  Supported events type.
Returns TypedEventTarget<E>

Methods

addEventListener

addEventListener<K extends string>(
    type: K,
    listener:
        | TypedEventListenerOrEventListenerObject<Extract<E, { type: K }>>
        | null,
    options?: boolean | AddEventListenerOptions,
): void
Appends an event listener for events of the given type.
Type Parameters
- K extends string
Parameters
- type: K
  Event type.
- listener: TypedEventListenerOrEventListenerObject<Extract<E, { type: K }>> | null
  Listener to append.
- Optionaloptions: boolean | AddEventListenerOptions
  Listener options.
Returns void
- Defined in src/TypedEventTarget.ts:36

`Protected`dispatchEvent

dispatchEvent<T extends string>(
    type: T,
    detail: Extract<E, { type: T }>["detail"],
    init?: Omit<CustomEventInit<Extract<E, { type: T }>["detail"]>, "detail">,
): boolean
Dispatches a new event of the given type.
Type Parameters
- T extends string
Parameters
- type: T
  Event type.
- detail: Extract<E, { type: T }>["detail"]
  Event detail.
- Optionalinit: Omit<CustomEventInit<Extract<E, { type: T }>["detail"]>, "detail">
  Event init options.
Returns boolean
false if the event was cancelled, otherwise true.
- Defined in src/TypedEventTarget.ts:81
dispatchEvent(event: E): boolean
Dispatches the given event.
Parameters
- event: E
  Event to dispatch.
Returns boolean
false if the event was cancelled, otherwise true.
- Defined in src/TypedEventTarget.ts:92

removeEventListener

removeEventListener<K extends string>(
    type: K,
    listener:
        | TypedEventListenerOrEventListenerObject<Extract<E, { type: K }>>
        | null,
    options?: boolean | EventListenerOptions,
): void
Removes an event listener for events of the given type.
Type Parameters
- K extends string
Parameters
- type: K
  Event type.
- listener: TypedEventListenerOrEventListenerObject<Extract<E, { type: K }>> | null
  Listener to remove.
- Optionaloptions: boolean | EventListenerOptions
  Listener options.
Returns void
- Defined in src/TypedEventTarget.ts:58