Class EventEmitter<Events>

constructor

• new EventEmitter<Events extends GenericEventMap>(
      all?: EventHandlerMap<Events>,
  ): EventEmitter<Events>

  Type Parameters

  • Events extends GenericEventMap

  Parameters

  • Optionalall: EventHandlerMap<Events>

  Returns EventEmitter<Events>

all

emit

• emit<Key extends string | number | symbol>(
      type: Key,
      ...payload: _ToTuple<Events[Key]>,
  ): void

  Invoke all handlers for the given type. If present, '*' handlers are invoked after type-matched handlers.

  Note: Manually firing '*' handlers is not supported.

  Type Parameters

  • Key extends string | number | symbol

  Parameters

  • type: Key

    The event type to invoke
  • ...payload: _ToTuple<Events[Key]>

    Any value to each handler

  Returns void

off

• off<Key extends string | number | symbol>(
      type: Key,
      handler?: _Handler<Events[Key]>,
  ): void

  Remove an event handler for the given type. If handler is omitted, all handlers of the given type are removed.

  Type Parameters

  • Key extends string | number | symbol

  Parameters

  • type: Key

    Type of event to unregister handler from, or '*'
  • Optionalhandler: _Handler<Events[Key]>

    Handler function to remove

  Returns void
• off(): void

  Remove all event handlers.

  Returns void

on

• on<Key extends string | number | symbol>(
      type: Key,
      handler: _Handler<Events[Key]>,
  ): _RemoveEventListener

  Register an event handler for the given type.

  Type Parameters

  • Key extends string | number | symbol

  Parameters

  • type: Key

    Type of event to listen for, or '*' for all events
  • handler: _Handler<Events[Key]>

    Function to call in response to given event

  Returns _RemoveEventListener
• on(type: "*", handler: _WildcardHandler<Events>): _RemoveEventListener

  Register an event handler for all events.

  Parameters

  • type: "*"

    '*'
  • handler: _WildcardHandler<Events>

    Function to call in response to given event

  Returns _RemoveEventListener