Type parameters

  • TEvent: string

Hierarchy

  • EventEmitter

Implements

Properties

Events: { [key: string]: string } = {}

Events of the Module in key-value notation. Key means the Enum name Value means the parameter to be passed to the EventEmitter

Type declaration

  • [key: string]: string

Constructors

Methods

  • Creates an event emitter instance to listen for the actions

    Returns

    Call the function to remove the event

    Parameters

    Returns () => void

      • (): void
      • Returns void

  • Creates an event emitter instance to listen for the actions

    Returns

    Call the function to remove the event

    Parameters

    Returns () => void

      • (): void
      • Returns void

  • emit(event: TEvent, ...args: any[]): void
  • Triggers the event manually.

    Parameters

    • event: TEvent
    • Rest ...args: any[]

    Returns void

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

    Parameters

    Returns void

  • Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

    Parameters

    Returns void

Generated using TypeDoc