Class EventEmitter<EventTypes, Context>

constructor

• new EventEmitter<EventTypes, Context>(): EventEmitter<EventTypes, Context>

• Type Parameters

  • EventTypes extends ValidEventTypes = string | symbol

  • Context extends unknown = any

  Returns EventEmitter<EventTypes, Context>

Static prefixed

addListener

• addListener<T>(event, fn, context?): this

• Type Parameters

  • T extends string | symbol

  Parameters

  • event: T

  • fn: EventListener<EventTypes, T>

  • Optional context: Context

  Returns this

emit

• emit<T>(event, ...args): boolean

• Calls each of the listeners registered for a given event.

  Type Parameters

  • T extends string | symbol

  Parameters

  • event: T

  • Rest ...args: Parameters<EventListener<EventTypes, T>>

  Returns boolean

eventNames

• eventNames(): EventNames<EventTypes>[]

• Return an array listing the events for which the emitter has registered listeners.

  Returns EventNames<EventTypes>[]

listenerCount

• listenerCount(event): number

• Return the number of listeners listening to a given event.

  Parameters

  • event: EventNames<EventTypes>

  Returns number

listeners

• listeners<T>(event): EventListener<EventTypes, T>[]

• Return the listeners registered for a given event.

  Type Parameters

  • T extends string | symbol

  Parameters

  • event: T

  Returns EventListener<EventTypes, T>[]

off

• off<T>(event, fn?, context?, once?): this

• Type Parameters

  • T extends string | symbol

  Parameters

  • event: T

  • Optional fn: EventListener<EventTypes, T>

  • Optional context: Context

  • Optional once: boolean

  Returns this

on

• on<T>(event, fn, context?): this

• Add a listener for a given event.

  Type Parameters

  • T extends string | symbol

  Parameters

  • event: T

  • fn: EventListener<EventTypes, T>

  • Optional context: Context

  Returns this

once

• once<T>(event, fn, context?): this

• Add a one-time listener for a given event.

  Type Parameters

  • T extends string | symbol

  Parameters

  • event: T

  • fn: EventListener<EventTypes, T>

  • Optional context: Context

  Returns this

removeAllListeners

• removeAllListeners(event?): this

• Remove all listeners, or those of the specified event.

  Parameters

  • Optional event: EventNames<EventTypes>

  Returns this

removeListener

• removeListener<T>(event, fn?, context?, once?): this

• Remove the listeners of a given event.

  Type Parameters

  • T extends string | symbol

  Parameters

  • event: T

  • Optional fn: EventListener<EventTypes, T>

  • Optional context: Context

  • Optional once: boolean

  Returns this