Class TypedEventEmitter<EventMap>

An implementation of a typed event target etc

Type Parameters

EventMap extends Record<string, any>

Hierarchy

EventTarget
- TypedEventEmitter

Implements

TypedEventTarget<EventMap>

Index

Constructors

Properties

Methods

addEventListener dispatchEvent listenerCount removeEventListener safeDispatchEvent

Constructors

constructor

new TypedEventEmitter<EventMap>(): TypedEventEmitter<EventMap>
Type Parameters
- EventMap extends Record<string, any>
Returns TypedEventEmitter<EventMap>
Overrides EventTarget.constructor
- Defined in packages/interface/src/event-target.ts:39

Properties

`Private` `Readonly` #listeners

#listeners: Map<any, Listener[]> = ...

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- listener: null | EventHandler<EventMap[K]>
- Optional options: boolean | AddEventListenerOptions
Returns void
Implementation of TypedEventTarget.addEventListener
Overrides EventTarget.addEventListener
- Defined in packages/interface/src/event-target.ts:57

dispatchEvent

dispatchEvent(event): 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
- event: Event
Returns boolean
Implementation of TypedEventTarget.dispatchEvent
Overrides EventTarget.dispatchEvent
- Defined in packages/interface/src/event-target.ts:88

listenerCount

listenerCount(type): number
Parameters
- type: string
Returns number
Implementation of TypedEventTarget.listenerCount
- Defined in packages/interface/src/event-target.ts:47

removeEventListener

removeEventListener<K>(type, listener?, options?): void
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- Optional listener: null | EventHandler<EventMap[K]>
- Optional options: boolean | EventListenerOptions
Returns void
Implementation of TypedEventTarget.removeEventListener
Overrides EventTarget.removeEventListener
- Defined in packages/interface/src/event-target.ts:74

safeDispatchEvent

safeDispatchEvent<Detail>(type, detail?): boolean
Type Parameters
- Detail
Parameters
- type: keyof EventMap
- detail: CustomEventInit<Detail> = {}
Returns boolean
Implementation of TypedEventTarget.safeDispatchEvent
- Defined in packages/interface/src/event-target.ts:103