TypedEmitter<Events>
Defined in: packages/transports/src/typed-emitter.ts:10
Minimal typed event emitter (on, once, off, emit) with no Node dependency, the base of every transport and of the Client.
Extended by
Type Parameters
Events
Events extends EventMap
Constructors
Constructor
new TypedEmitter<Events>(): TypedEmitter<Events>;Returns
TypedEmitter<Events>
Methods
emit()
emit<K>(event, ...args): boolean;Defined in: packages/transports/src/typed-emitter.ts:44
Type Parameters
K
K extends string
Parameters
event
K
Event name
args
...Events[K]
Event arguments
Returns
boolean
listenerCount()
listenerCount<K>(event): number;Defined in: packages/transports/src/typed-emitter.ts:49
Type Parameters
K
K extends string
Parameters
event
K
Event name
Returns
number
off()
off<K>(event, listener): this;Defined in: packages/transports/src/typed-emitter.ts:35
Type Parameters
K
K extends string
Parameters
event
K
Event name
listener
Listener<Events[K]>
Listener to remove
Returns
this
on()
on<K>(event, listener): this;Defined in: packages/transports/src/typed-emitter.ts:17
Type Parameters
K
K extends string
Parameters
event
K
Event name
listener
Listener<Events[K]>
Called with the event arguments
Returns
this
once()
once<K>(event, listener): this;Defined in: packages/transports/src/typed-emitter.ts:26
Type Parameters
K
K extends string
Parameters
event
K
Event name
listener
Listener<Events[K]>
Called once with the event arguments
Returns
this
removeAllListeners()
removeAllListeners<K>(event?): this;Defined in: packages/transports/src/typed-emitter.ts:54
Type Parameters
K
K extends string
Parameters
event?
K
Event name, or every event when omitted
Returns
this