Class EventEmitter<TEvents>

Type Parameters

TEvents extends Record<string, unknown[]>

Hierarchy (view full)

EventEmitter

Index

Constructors

Methods

on off once emit removeAllListeners listenerCount

Constructors

constructor

new EventEmitter<TEvents>(): EventEmitter<TEvents>
Type Parameters
- TEvents extends Record<string, unknown[]>
Returns EventEmitter<TEvents>

Methods

on

on<K>(event, listener): this
Register an event listener
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: EventListener<TEvents[K]>
Returns this
- Defined in transport/event-emitter.ts:17

off

off<K>(event, listener): this
Remove an event listener
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: EventListener<TEvents[K]>
Returns this
- Defined in transport/event-emitter.ts:28

once

once<K>(event, listener): this
Register a one-time event listener
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: EventListener<TEvents[K]>
Returns this
- Defined in transport/event-emitter.ts:37

`Protected` emit

emit<K>(event, ...args): boolean
Emit an event
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- Rest ...args: TEvents[K]
Returns boolean
- Defined in transport/event-emitter.ts:48

removeAllListeners

removeAllListeners<K>(event?): this
Remove all listeners for an event, or all events
Type Parameters
- K extends string | number | symbol
Parameters
- Optional event: K
Returns this
- Defined in transport/event-emitter.ts:76

listenerCount

listenerCount<K>(event): number
Get the number of listeners for an event
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
Returns number
- Defined in transport/event-emitter.ts:90