Class TypedEventEmitter<E>`Abstract`

Type Parameters

E extends EventMap

Hierarchy (View Summary)

TypedEventEmitter

Index

Constructors

Properties

Methods

emit off on once removeAllListeners

Constructors

constructor

new TypedEventEmitter<E extends EventMap>(): TypedEventEmitter<E>
Type Parameters
- E extends EventMap
Returns TypedEventEmitter<E>

Properties

`Protected`listeners

listeners: { [K in string | number | symbol]?: (data: E[K]) => void[] } = {}

Methods

`Protected`emit

emit<T extends string | number | symbol>(event: T, data: E[T]): void
Dispatch an event to all listeners
Type Parameters
- T extends string | number | symbol
Parameters
- event: T
- data: E[T]
Returns void
- Defined in lib/TypedEventEmitter.ts:69

off

off<T extends string | number | symbol>(
event: T,
listener: (data: E[T]) => void,
): void
Remove an event listener
Type Parameters
- T extends string | number | symbol
Parameters
- event: T
- listener: (data: E[T]) => void
Returns void
- Defined in lib/TypedEventEmitter.ts:45

on

on<T extends string | number | symbol>(
event: T,
listener: (data: E[T]) => void,
): () => void
Add an event listener, returns a function that can be called to remove the listener
Type Parameters
- T extends string | number | symbol
Parameters
- event: T
- listener: (data: E[T]) => void
Returns () => void
- Defined in lib/TypedEventEmitter.ts:17

once

once<T extends string | number | symbol>(
event: T,
listener: (data: E[T]) => void,
): () => void
Add an event listener that will be called only once
Type Parameters
- T extends string | number | symbol
Parameters
- event: T
- listener: (data: E[T]) => void
Returns () => void
- Defined in lib/TypedEventEmitter.ts:32

removeAllListeners

removeAllListeners<T extends string | number | symbol>(event?: T): void
Remove all event listeners, optionally for a specific event
Type Parameters
- T extends string | number | symbol
Parameters
- Optionalevent: T
Returns void
- Defined in lib/TypedEventEmitter.ts:56