Skip to main content

TypedEventEmitter

TypedEventEmitter<Events>: object

Type Parameters

Type Parameter
Events extends EventMap

Type declaration

addListener()

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>

emit()

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

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

Returns

boolean

eventNames()

Returns

(string | symbol | keyof Events)[]

getMaxListeners()

Returns

number

listenerCount()

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE

Returns

number

listeners()

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE

Returns

Events[E][]

off()

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>

on()

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>

once()

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>

prependListener()

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>

prependOnceListener()

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>

removeAllListeners()

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
event?E

Returns

TypedEventEmitter<Events>

removeListener()

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

ParameterType
eventE
listenerEvents[E]

Returns

TypedEventEmitter<Events>