FTEventEmitter

Special case of the EventEmitter which is configured to emit events defined in events.FTEvents

interface FTEventEmitter {
    emit<K extends keyof FTEvents>(event: K, ...args: FTEvents[K]): void;
    off<K extends keyof FTEvents>(
        event: K,
        listener: Listener<FTEvents[K]>,
    ): void;
    on<K extends keyof FTEvents>(
        event: K,
        listener: Listener<FTEvents[K]>,
    ): () => void;
}

Hierarchy (View Summary)

• EventEmitter<FTEvents>
  • FTEventEmitter

Methods

emit

• emit<K extends keyof FTEvents>(event: K, ...args: FTEvents[K]): void

  Fires the event, calling all registered listeners with the provided arguments.

  Type Parameters

  • K extends keyof FTEvents

  Parameters

  • event: K

    The event name.

  • ...args: FTEvents[K]

    The arguments for the listeners.

  Returns void

  Inherited from EventEmitter.emit

off

• off<K extends keyof FTEvents>(event: K, listener: Listener<FTEvents[K]>): void

  Removes a listener for the event.

  Type Parameters

  • K extends keyof FTEvents

  Parameters

  • event: K

    The event name.

  • listener: Listener<FTEvents[K]>

    The listener callback.

  Returns void

  Inherited from EventEmitter.off

on

• on<K extends keyof FTEvents>(
      event: K,
      listener: Listener<FTEvents[K]>,
  ): () => void

  Registers a new listener for the event.

  Type Parameters

  • K extends keyof FTEvents

  Parameters

  • event: K

    The event name.

  • listener: Listener<FTEvents[K]>

    The listener callback.

  Returns () => void

  A function that removes the listener when called.

  Inherited from EventEmitter.on