Interface EventedOn<Events>

Type Parameters

• Events

• EventedOn<Name extends string>(
      eventName: Name,
      callback: EventCallback<Events[Name]>,
  ): EventHandle

  Register event listener for specific events.

  Type Parameters

  • Name extends string

  Parameters

  • eventName: Name

    name of the event

  • callback: EventCallback<Events[Name]>

    the event handler callback will be invoked when the event has been emitted

  Returns EventHandle

  a handle to unregister from the event

• EventedOn(
      eventName: "*",
      callback: EventCallback<Events[EventNames<Events>]>,
  ): EventHandle

  Register event listener for any event.

  Parameters

  • eventName: "*"

    must be "*" for this overload

  • callback: EventCallback<Events[EventNames<Events>]>

    the event handler callback will be invoked when any event has been emitted

  Returns EventHandle

  a handle to unregister from the events

• EventedOn(
      eventName: string | string[],
      callback: EventCallback<unknown>,
  ): EventHandle

  Register event listener for the events listed in eventName. Comma separated event names are possible, for example "eventA,eventB".

  Parameters

  • eventName: string | string[]

    the event name or list of names

  • callback: EventCallback<unknown>

    the event handler callback

  Returns EventHandle

  a handle to unregister from the event(s)