Class FTEventEmitter

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

Hierarchy (view full)

EventEmitter<FTEvents>
- FTEventEmitter

Index

Constructors

Methods

Constructors

constructor

new FTEventEmitter(): FTEventEmitter
Returns FTEventEmitter
Inherited from EventEmitter.constructor

Methods

emit

emit<K>(event, ...args): void
Fires the event, calling all registered listeners with the provided arguments.
Type Parameters
- K extends keyof FTEvents
Parameters
- event: K
  The event name.
- Rest ...args: FTEvents[K]
  The arguments for the listeners.
Returns void
Inherited from EventEmitter.emit

off

off<K>(event, listener): 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>(event, listener): (() => 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.
- - (): void
  - Returns void
Inherited from EventEmitter.on