Class EventEmitter<T>

A simple event emitter.

Type Parameters

T extends EventDataMap

Hierarchy (view full)

EventEmitter
- Task

Index

Constructors

Properties

Methods

emit off on once tap untap wait

Constructors

constructor

new EventEmitter<T>(): EventEmitter<T>
Type Parameters
- T extends EventDataMap
Returns EventEmitter<T>

Properties

`Private` listeners

listeners: {
[k in string | number | symbol]?: Set<ListenerFn<T[k]>>
} = {}

`Private` taps

taps: Set<TapFn<T>> = ...

Methods

emit

emit<E>(event, data): void
Emit an event with data. This will call all listeners for the event and all taps of this emitter.
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- data: T[E]
Returns void
- Defined in src/common/event-emitter.ts:32

off

off<E>(event, listener): void
Remove a listener for an event.
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: ListenerFn<T[E]>
Returns void
- Defined in src/common/event-emitter.ts:48

on

on<E>(event, listener): void
Register a listener for an event.
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: ListenerFn<T[E]>
Returns void
- Defined in src/common/event-emitter.ts:40

once

once<E>(event, listener): void
Register a listener for an event that will only be called once.
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
- listener: ListenerFn<T[E]>
Returns void
- Defined in src/common/event-emitter.ts:69

tap

tap(fn): void
Tap into all events.
Parameters
- fn: TapFn<T>
Returns void
- Defined in src/common/event-emitter.ts:55

untap

untap(fn): void
Stop tapping into all events for a TapFn.
Parameters
- fn: TapFn<T>
Returns void
- Defined in src/common/event-emitter.ts:62

wait

wait<E>(event): Promise<T[E]>
Wait for an event to be emitted once. This is the async version of once.
Type Parameters
- E extends string | number | symbol
Parameters
- event: E
Returns Promise<T[E]>
- Defined in src/common/event-emitter.ts:80