1681-engine / index / EventBus
Class: EventBus<Events> ​
Defined in: src/events/EventBus.ts:7
Typed observer: listeners subscribe per event name and run in subscription order. Events maps each event name to its payload, e.g. EventBus<{ enemyKilled: { id: number } }>.
A listener that throws does not stop the ones after it; the error is handed to onError (the console by default).
Type Parameters ​
| Type Parameter |
|---|
Events extends object |
Constructors ​
Constructor ​
new EventBus<Events>(onError?): EventBus<Events>;Defined in: src/events/EventBus.ts:10
Parameters ​
| Parameter | Type |
|---|---|
onError | (type, err) => void |
Returns ​
EventBus<Events>
Methods ​
clear() ​
clear(): void;Defined in: src/events/EventBus.ts:50
Returns ​
void
emit() ​
emit<K>(type, payload): void;Defined in: src/events/EventBus.ts:35
Type Parameters ​
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters ​
| Parameter | Type |
|---|---|
type | K |
payload | Events[K] |
Returns ​
void
listenerCount() ​
listenerCount(type): number;Defined in: src/events/EventBus.ts:46
Parameters ​
| Parameter | Type |
|---|---|
type | keyof Events |
Returns ​
number
off() ​
off<K>(type, fn): void;Defined in: src/events/EventBus.ts:27
Type Parameters ​
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters ​
| Parameter | Type |
|---|---|
type | K |
fn | (payload) => void |
Returns ​
void
on() ​
on<K>(type, fn): () => void;Defined in: src/events/EventBus.ts:13
Subscribes to type; returns the unsubscribe function.
Type Parameters ​
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters ​
| Parameter | Type |
|---|---|
type | K |
fn | (payload) => void |
Returns ​
() => void
once() ​
once<K>(type, fn): () => void;Defined in: src/events/EventBus.ts:19
Subscribes for the next type only.
Type Parameters ​
| Type Parameter |
|---|
K extends string | number | symbol |
Parameters ​
| Parameter | Type |
|---|---|
type | K |
fn | (payload) => void |
Returns ​
() => void