Skip to main content

TypedEventEmitter

TypedEventEmitter<Events> = object

Type Parameters

Type Parameter
Events extends EventMap

Methods

addListener()

addListener<E>(event: E, listener: Events[E]): TypedEventEmitter<Events>

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>


emit()

emit<E>(event: E, ...args: Parameters<Events[E]>): boolean

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
...argsParameters<Events[E]>

Returns

boolean


eventNames()

eventNames(): (string | symbol | keyof Events)[]

Returns

(string | symbol | keyof Events)[]


getMaxListeners()

getMaxListeners(): number

Returns

number


listenerCount()

listenerCount<E>(event: E): number

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE

Returns

number


listeners()

listeners<E>(event: E): Events[E][]

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE

Returns

Events[E][]


off()

off<E>(event: E, listener: Events[E]): TypedEventEmitter<Events>

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>


on()

on<E>(event: E, listener: Events[E]): TypedEventEmitter<Events>

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>


once()

once<E>(event: E, listener: Events[E]): TypedEventEmitter<Events>

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>


prependListener()

prependListener<E>(event: E, listener: Events[E]): TypedEventEmitter<Events>

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>


prependOnceListener()

prependOnceListener<E>(event: E, listener: Events[E]): TypedEventEmitter<Events>

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>


removeAllListeners()

removeAllListeners<E>(event?: E): TypedEventEmitter<Events>

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
event?E

Returns

TypedEventEmitter<Events>


removeListener()

removeListener<E>(event: E, listener: Events[E]): TypedEventEmitter<Events>

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>