Class EventEmitter

Staticprefixed

addListener

• addListener<T extends keyof EventPayloadMap>(
      event: T,
      fn: (
          ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
              T,
              keyof EventPayloadMap,
          >],
      ) => void,
      context?: any,
  ): this

  Type Parameters

  • T extends keyof EventPayloadMap

  Parameters

  • event: T
  • fn: (
        ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
            T,
            keyof EventPayloadMap,
        >],
    ) => void
  • Optionalcontext: any

  Returns this

emit

• emit<T extends keyof EventPayloadMap>(
      event: T,
      ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
          T,
          keyof EventPayloadMap,
      >],
  ): boolean

  Calls each of the listeners registered for a given event.

  Type Parameters

  • T extends keyof EventPayloadMap

  Parameters

  • event: T
  • ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<T, keyof EventPayloadMap>]

  Returns boolean

eventNames

• eventNames(): (keyof EventPayloadMap)[]

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

  Returns (keyof EventPayloadMap)[]

listenerCount

• listenerCount(event: keyof EventPayloadMap): number

  Return the number of listeners listening to a given event.

  Parameters

  • event: keyof EventPayloadMap

  Returns number

listeners

• listeners<T extends keyof EventPayloadMap>(
      event: T,
  ): (
      (
          ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
              T,
              keyof EventPayloadMap,
          >],
      ) => void
  )[]

  Return the listeners registered for a given event.

  Type Parameters

  • T extends keyof EventPayloadMap

  Parameters

  • event: T

  Returns (
      (
          ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
              T,
              keyof EventPayloadMap,
          >],
      ) => void
  )[]

off

• off<T extends keyof EventPayloadMap>(
      event: T,
      fn?: (
          ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
              T,
              keyof EventPayloadMap,
          >],
      ) => void,
      context?: any,
      once?: boolean,
  ): this

  Type Parameters

  • T extends keyof EventPayloadMap

  Parameters

  • event: T
  • Optionalfn: (
        ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
            T,
            keyof EventPayloadMap,
        >],
    ) => void
  • Optionalcontext: any
  • Optionalonce: boolean

  Returns this

on

• on<T extends keyof EventPayloadMap>(
      event: T,
      fn: (
          ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
              T,
              keyof EventPayloadMap,
          >],
      ) => void,
      context?: any,
  ): this

  Add a listener for a given event.

  Type Parameters

  • T extends keyof EventPayloadMap

  Parameters

  • event: T
  • fn: (
        ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
            T,
            keyof EventPayloadMap,
        >],
    ) => void
  • Optionalcontext: any

  Returns this

once

• once<T extends keyof EventPayloadMap>(
      event: T,
      fn: (
          ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
              T,
              keyof EventPayloadMap,
          >],
      ) => void,
      context?: any,
  ): this

  Add a one-time listener for a given event.

  Type Parameters

  • T extends keyof EventPayloadMap

  Parameters

  • event: T
  • fn: (
        ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
            T,
            keyof EventPayloadMap,
        >],
    ) => void
  • Optionalcontext: any

  Returns this

removeAllListeners

• removeAllListeners(event?: keyof EventPayloadMap): this

  Remove all listeners, or those of the specified event.

  Parameters

  • Optionalevent: keyof EventPayloadMap

  Returns this

removeListener

• removeListener<T extends keyof EventPayloadMap>(
      event: T,
      fn?: (
          ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
              T,
              keyof EventPayloadMap,
          >],
      ) => void,
      context?: any,
      once?: boolean,
  ): this

  Remove the listeners of a given event.

  Type Parameters

  • T extends keyof EventPayloadMap

  Parameters

  • event: T
  • Optionalfn: (
        ...args: ArgumentMap<EventEmitterValidEventTypes>[Extract<
            T,
            keyof EventPayloadMap,
        >],
    ) => void
  • Optionalcontext: any
  • Optionalonce: boolean

  Returns this