Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventEmitterInt<Events>

Type parameters

  • Events: object

Hierarchy

  • EventEmitterInt

Implemented by

Index

event dispatching Methods

listener adding Methods

listener removing Methods

event dispatching Methods

dispatch

  • dispatch<Name>(name: Name, event: Events[Name]): void
  • This method calls all listeners registered on this event name with the event instance provided as argument.

    Be aware that this method does not handle thrown errors and other misbehaving listeners. The listeners will be called synchronously in their order in which they were added.

    Type parameters

    • Name: keyof Events

    Parameters

    • name: Name
    • event: Events[Name]

    Returns void

publish

  • publish<Name>(name: Name, event: Events[Name]): void

push

  • push<Name>(name: Name, event: Events[Name]): void

listener adding Methods

addEventListener

  • addEventListener<Name>(name: Name, listener: (ev: Events[Name]) => void): void
  • Adds an listener which is synchronously called in order in which they were added. This listener will receive the event given by the corresponding dispatch call.

    Type parameters

    • Name: keyof Events

    Parameters

    • name: Name

      the name of the event (key in the Events generic argument)

    • listener: (ev: Events[Name]) => void

      the listener you want to attach to that event

        • (ev: Events[Name]): void
        • Parameters

          • ev: Events[Name]

          Returns void

    Returns void

addListener

  • addListener<Name>(name: Name, listener: (ev: Events[Name]) => void): void
  • Alias for addEventListener

    alias

    addEventListener

    Type parameters

    • Name: keyof Events

    Parameters

    • name: Name

      the name of the event (key in the Events generic argument)

    • listener: (ev: Events[Name]) => void

      the listener you want to attach to that event

        • (ev: Events[Name]): void
        • Parameters

          • ev: Events[Name]

          Returns void

    Returns void

on

  • on<Name>(name: Name, listener: (ev: Events[Name]) => void): void
  • Alias for addEventListener

    alias

    addEventListener

    Type parameters

    • Name: keyof Events

    Parameters

    • name: Name

      the name of the event (key in the Events generic argument)

    • listener: (ev: Events[Name]) => void

      the listener you want to attach to that event

        • (ev: Events[Name]): void
        • Parameters

          • ev: Events[Name]

          Returns void

    Returns void

once

  • once<Name>(name: Name, listener: (ev: Events[Name]) => void): void
  • This function attaches a listener which will be removed at its first call.

    Type parameters

    • Name: keyof Events

    Parameters

    • name: Name

      the name of the event (key in the Events generic argument)

    • listener: (ev: Events[Name]) => void

      the listener you want to attach to that event

        • (ev: Events[Name]): void
        • Parameters

          • ev: Events[Name]

          Returns void

    Returns void

subscribe

  • subscribe<Name>(name: Name, listener: (ev: Events[Name]) => void): void
  • Alias for addEventListener

    alias

    addEventListener

    Type parameters

    • Name: keyof Events

    Parameters

    • name: Name

      the name of the event (key in the Events generic argument)

    • listener: (ev: Events[Name]) => void

      the listener you want to attach to that event

        • (ev: Events[Name]): void
        • Parameters

          • ev: Events[Name]

          Returns void

    Returns void

waitFor

  • waitFor<Name>(name: Name): Promise<Events[Name]>
  • This methods returns a promise which will be resolved when the event is dispatched. The Promise resolves to the event.

    Type parameters

    • Name: keyof Events

    Parameters

    • name: Name

    Returns Promise<Events[Name]>

listener removing Methods

off

  • off<Name>(name: Name, listener: (ev: Events[Name]) => void): boolean
  • Type parameters

    • Name: keyof Events

    Parameters

    • name: Name
    • listener: (ev: Events[Name]) => void
        • (ev: Events[Name]): void
        • Parameters

          • ev: Events[Name]

          Returns void

    Returns boolean

removeEventListener

  • removeEventListener<Name>(name: Name, listener: (ev: Events[Name]) => void): boolean
  • Removes the given listener from the list of listeners for the given name.

    Type parameters

    • Name: keyof Events

    Parameters

    • name: Name
    • listener: (ev: Events[Name]) => void
        • (ev: Events[Name]): void
        • Parameters

          • ev: Events[Name]

          Returns void

    Returns boolean

removeListener

  • removeListener<Name>(name: Name, listener: (ev: Events[Name]) => void): boolean
  • Type parameters

    • Name: keyof Events

    Parameters

    • name: Name
    • listener: (ev: Events[Name]) => void
        • (ev: Events[Name]): void
        • Parameters

          • ev: Events[Name]

          Returns void

    Returns boolean

unsubscribe

  • unsubscribe<Name>(name: Name, listener: (ev: Events[Name]) => void): boolean
  • Type parameters

    • Name: keyof Events

    Parameters

    • name: Name
    • listener: (ev: Events[Name]) => void
        • (ev: Events[Name]): void
        • Parameters

          • ev: Events[Name]

          Returns void

    Returns boolean

Generated using TypeDoc