Class EventEmitter<TEvents>

Type Parameters

TEvents extends Events = Events

Hierarchy

EventEmitter

Index

Constructors

Properties

listeners listenersOnce instance?

Methods

emit eventNames has listenerCount off on once prependListener prependOnceListener getInstance

Constructors

`Private` constructor

new EventEmitter<TEvents>(): EventEmitter<TEvents>
Type Parameters
- TEvents extends Events = Events
Returns EventEmitter<TEvents>
- Defined in src/Support/EventEmitter.ts:14

Properties

`Protected` listeners

listeners: TEvents = ...

The Listeners that always run.

`Protected` listenersOnce

listenersOnce: TEvents = ...

The Listeners that only runs once.

`Static` `Private` `Optional` instance

instance?: any

The singleton.

Methods

emit

emit<P>(event: P, ...args: Parameters<TEvents[P][number]>): Promise<EventEmitter<TEvents>>
Fire the event.
Type Parameters
- P extends string | number | symbol
Parameters
- event: P
  
  The event name.
- Rest ...args: Parameters<TEvents[P][number]>
  
  The arguments to pass to the listeners.
Returns Promise<EventEmitter<TEvents>>
- Defined in src/Support/EventEmitter.ts:48

eventNames

eventNames(): (keyof TEvents)[]
Get all the even names currently listened to.

Returns (keyof TEvents)[]
- Defined in src/Support/EventEmitter.ts:237

has

has<P>(event?: P, listener?: Listener<Parameters<TEvents[P][number]>[number]>): boolean
Determine whether listeners exist.
Type Parameters
- P extends string | number | symbol
Parameters
- Optional event: P
  
  only check for listeners for the given event
- Optional listener: Listener<Parameters<TEvents[P][number]>[number]>
  
  only check for listeners that match this given listener
Returns boolean
- Defined in src/Support/EventEmitter.ts:177

listenerCount

listenerCount(event?: keyof TEvents): number
Get the number of listeners registered.
Parameters
- Optional event: keyof TEvents
  
  only count the listeners for the given event
Returns number
- Defined in src/Support/EventEmitter.ts:208

off

off<P>(event?: P, listener?: TEvents[P][number]): EventEmitter<TEvents>
Remove the listeners.
Type Parameters
- P extends string | number | symbol
Parameters
- Optional event: P
  
  only remove listeners for the given event
- Optional listener: TEvents[P][number]
  
  only remove the event listener that match the given listener.
Returns EventEmitter<TEvents>
- Defined in src/Support/EventEmitter.ts:71

on

on<P>(event: P, listener: Listener<Parameters<TEvents[P][number]>[number]>): EventEmitter<TEvents>
Bind the event listener.
Type Parameters
- P extends string | number | symbol
Parameters
- event: P
- listener: Listener<Parameters<TEvents[P][number]>[number]>
Returns EventEmitter<TEvents>
- Defined in src/Support/EventEmitter.ts:116

once

once<P>(event: P, listener: Listener<Parameters<TEvents[P][number]>[number]>): EventEmitter<TEvents>
Bind the event listener that should only run once.
Type Parameters
- P extends string | number | symbol
Parameters
- event: P
- listener: Listener<Parameters<TEvents[P][number]>[number]>
Returns EventEmitter<TEvents>
- Defined in src/Support/EventEmitter.ts:129

prependListener

prependListener<P>(event: P, listener: Listener<Parameters<TEvents[P][number]>[number]>): EventEmitter<TEvents>
Bind the event and to the front of the stack.
Type Parameters
- P extends string | number | symbol
Parameters
- event: P
- listener: Listener<Parameters<TEvents[P][number]>[number]>
Returns EventEmitter<TEvents>
- Defined in src/Support/EventEmitter.ts:142

prependOnceListener

prependOnceListener<P>(event: P, listener: Listener<Parameters<TEvents[P][number]>[number]>): EventEmitter<TEvents>
Bind the event that only runs once to the front of the stack.
Type Parameters
- P extends string | number | symbol
Parameters
- event: P
- listener: Listener<Parameters<TEvents[P][number]>[number]>
Returns EventEmitter<TEvents>
- Defined in src/Support/EventEmitter.ts:158

`Static` getInstance

getInstance<TEvents>(): EventEmitter<TEvents>
Get the singleton.
Type Parameters
- TEvents extends Events
Returns EventEmitter<TEvents>
- Defined in src/Support/EventEmitter.ts:20

Generated using TypeDoc