Interface: EventEmitterLike<TEvents extends { [K in keyof TEvents]: unknown[] }>
SDK-owned types keep Node's emitter declarations out of browser consumers.
Type Parameters
| Type Parameter |
|---|
TEvents extends { [K in keyof TEvents]: unknown[] } |
Methods
addListener()
ts
addListener<K extends string | number | symbol>(event: K, listener: (...args: TEvents[K]) => void): this;Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | (...args: TEvents[K]) => void |
Returns
this
emit()
ts
emit<K extends string | number | symbol>(event: K, ...args: TEvents[K]): boolean;Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
event | K |
...args | TEvents[K] |
Returns
boolean
eventNames()
ts
eventNames(): (keyof TEvents)[];Returns
(keyof TEvents)[]
getMaxListeners()
ts
getMaxListeners(): number;Returns
number
listenerCount()
ts
listenerCount<K extends string | number | symbol>(event: K, listener?: (...args: TEvents[K]) => void): number;Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener? | (...args: TEvents[K]) => void |
Returns
number
listeners()
ts
listeners<K extends string | number | symbol>(event: K): ((...args: TEvents[K]) => void)[];Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
event | K |
Returns
((...args: TEvents[K]) => void)[]
off()
ts
off<K extends string | number | symbol>(event: K, listener: (...args: TEvents[K]) => void): this;Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | (...args: TEvents[K]) => void |
Returns
this
on()
ts
on<K extends string | number | symbol>(event: K, listener: (...args: TEvents[K]) => void): this;Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | (...args: TEvents[K]) => void |
Returns
this
once()
ts
once<K extends string | number | symbol>(event: K, listener: (...args: TEvents[K]) => void): this;Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | (...args: TEvents[K]) => void |
Returns
this
prependListener()
ts
prependListener<K extends string | number | symbol>(event: K, listener: (...args: TEvents[K]) => void): this;Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | (...args: TEvents[K]) => void |
Returns
this
prependOnceListener()
ts
prependOnceListener<K extends string | number | symbol>(event: K, listener: (...args: TEvents[K]) => void): this;Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | (...args: TEvents[K]) => void |
Returns
this
rawListeners()
ts
rawListeners<K extends string | number | symbol>(event: K): ((...args: TEvents[K]) => void)[];Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
event | K |
Returns
((...args: TEvents[K]) => void)[]
removeAllListeners()
ts
removeAllListeners(event?: keyof TEvents): this;Parameters
| Parameter | Type |
|---|---|
event? | keyof TEvents |
Returns
this
removeListener()
ts
removeListener<K extends string | number | symbol>(event: K, listener: (...args: TEvents[K]) => void): this;Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | (...args: TEvents[K]) => void |
Returns
this
setMaxListeners()
ts
setMaxListeners(count: number): this;Parameters
| Parameter | Type |
|---|---|
count | number |
Returns
this