Class Emitter<EventType>

Readonly name

dispose

• dispose(): this

• Clean up

  Returns this

emit

• emit(event, ...args): this

• Invoke all of the callbacks bound to the event with any arguments passed in.

  Parameters

  • event: EventType

    The name of the event.
  • Rest ...args: any[]

    The arguments to pass to the functions listening.

  Returns this

off

• off(event, callback?): this

• Remove the event listener.

  Parameters

  • event: EventType

    The event to stop listening to.
  • Optional callback: ((...args) => void)

    The callback which was bound to the event with Emitter.on. If no callback is given, all callbacks events are removed.

    • • (...args): void

      • Parameters

        • Rest ...args: any[]

        Returns void

  Returns this

on

• on(event, callback): this

• Bind a callback to a specific event.

  Parameters

  • event: EventType

    The name of the event to listen for.
  • callback: ((...args) => void)

    The callback to invoke when the event is emitted

    • • (...args): void

      • Parameters

        • Rest ...args: any[]

        Returns void

  Returns this

once

• once(event, callback): this

• Bind a callback which is only invoked once

  Parameters

  • event: EventType

    The name of the event to listen for.
  • callback: ((...args) => void)

    The callback to invoke when the event is emitted

    • • (...args): void

      • Parameters

        • Rest ...args: any[]

        Returns void

  Returns this

Static mixin

• mixin(constr): void

• Add Emitter functions (on/off/emit) to the object

  Parameters

  • constr: any

  Returns void