Class EventEmitter<EventMap>

Adds types to the EventTarget class. Hopefully this won't be necessary forever.

https://github.com/microsoft/TypeScript/issues/28357 https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

Type Parameters

EventMap extends Record<string, any>

Hierarchy

EventTarget
- EventEmitter
  - PubSub
  - Listener
  - Libp2p

Index

Constructors

Properties

Methods

addEventListener dispatchEvent listenerCount removeEventListener safeDispatchEvent

Constructors

constructor

new EventEmitter<EventMap>(): EventEmitter<EventMap>
Type Parameters
- EventMap extends Record<string, any>
Returns EventEmitter<EventMap>
Inherited from EventTarget.constructor
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5316

Properties

`Private` #private

#private: any

Methods

addEventListener

addEventListener<K>(type: K, listener: null | EventHandler<EventMap[K]>, options?: boolean | AddEventListenerOptions): void
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- listener: null | EventHandler<EventMap[K]>
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in packages/interfaces/dist/src/events.d.ts:19

dispatchEvent

dispatchEvent(event: Event): boolean
Parameters
- event: Event
Returns boolean
Overrides EventTarget.dispatchEvent
- Defined in packages/interfaces/dist/src/events.d.ts:21

listenerCount

listenerCount(type: string): number
Parameters
- type: string
Returns number
- Defined in packages/interfaces/dist/src/events.d.ts:18

removeEventListener

removeEventListener<K>(type: K, listener?: null | EventHandler<EventMap[K]>, options?: boolean | EventListenerOptions): void
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- Optional listener: null | EventHandler<EventMap[K]>
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in packages/interfaces/dist/src/events.d.ts:20

safeDispatchEvent

safeDispatchEvent<Detail>(type: keyof EventMap, detail: CustomEventInit<Detail>): boolean
Type Parameters
- Detail
Parameters
- type: keyof EventMap
- detail: CustomEventInit<Detail>
Returns boolean
- Defined in packages/interfaces/dist/src/events.d.ts:22