Class Client

Staticprefixed

addListener

• addListener<T extends string | symbol>(
      event: T,
      fn: (...args: any[]) => void,
      context?: any,
  ): this

• Type Parameters

  • T extends string | symbol

  Parameters

  • event: T
  • fn: (...args: any[]) => void
  • Optionalcontext: any

  Returns this

emit

• emit<T extends string | symbol>(event: T, ...args: any[]): boolean

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

  Type Parameters

  • T extends string | symbol

  Parameters

  • event: T
  • ...args: any[]

  Returns boolean

eventNames

• eventNames(): (string | symbol)[]

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

  Returns (string | symbol)[]

listenerCount

• listenerCount(event: string | symbol): number

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

  Parameters

  • event: string | symbol

  Returns number

listeners

• listeners<T extends string | symbol>(event: T): (...args: any[]) => void[]

• Return the listeners registered for a given event.

  Type Parameters

  • T extends string | symbol

  Parameters

  • event: T

  Returns (...args: any[]) => void[]

off

• off<T extends string | symbol>(
      event: T,
      fn?: (...args: any[]) => void,
      context?: any,
      once?: boolean,
  ): this

• Type Parameters

  • T extends string | symbol

  Parameters

  • event: T
  • Optionalfn: (...args: any[]) => void
  • Optionalcontext: any
  • Optionalonce: boolean

  Returns this

on

• on<T extends string | symbol>(
      event: T,
      fn: (...args: any[]) => void,
      context?: any,
  ): this

• Add a listener for a given event.

  Type Parameters

  • T extends string | symbol

  Parameters

  • event: T
  • fn: (...args: any[]) => void
  • Optionalcontext: any

  Returns this

once

• once<T extends string | symbol>(
      event: T,
      fn: (...args: any[]) => void,
      context?: any,
  ): this

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

  Type Parameters

  • T extends string | symbol

  Parameters

  • event: T
  • fn: (...args: any[]) => void
  • Optionalcontext: any

  Returns this

removeAllListeners

• removeAllListeners(event?: string | symbol): this

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

  Parameters

  • Optionalevent: string | symbol

  Returns this

removeListener

• removeListener<T extends string | symbol>(
      event: T,
      fn?: (...args: any[]) => void,
      context?: any,
      once?: boolean,
  ): this

• Remove the listeners of a given event.

  Type Parameters

  • T extends string | symbol

  Parameters

  • event: T
  • Optionalfn: (...args: any[]) => void
  • Optionalcontext: any
  • Optionalonce: boolean

  Returns this