Class: EventBus<EventMap>

Type Parameters

Type Parameter	Default type
EventMap extends Record<string, unknown>	Record<string, unknown>

Constructors

Constructor

new EventBus<EventMap>(): EventBus<EventMap>;

Returns

EventBus<EventMap>

Properties

Property	Modifier	Type
shared	readonly	EventBus

Methods

Clear()

Clear(): void;

Returns

void

---

Emit()

Emit<K>(eventName, payload): void;

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

Parameter	Type
eventName	K
payload	EventMap[K]

Returns

void

---

ListenerCount()

ListenerCount(eventName?): number;

Parameters

Parameter	Type
eventName?	keyof EventMap

Returns

number

---

Off()

Off<K>(
   eventName, 
   listener?, 
   context?
): void;

Off(name) clears everything for name; (name, cb) matches by callback; (name, cb, ctx) matches the (cb, ctx) pair exactly.

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

Parameter	Type
eventName	K
listener?	EventListener<EventMap[K]>
context?	object

Returns

void

---

OffAllForContext()

OffAllForContext(context): void;

Parameters

Parameter	Type
context	object

Returns

void

---

On()

On<K>(
   eventName, 
   listener, 
   context?
): EventUnsubscribe;

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

Parameter	Type
eventName	K
listener	EventListener<EventMap[K]>
context?	object

Returns

EventUnsubscribe

---

OnAny()

OnAny(listener): EventUnsubscribe;

Parameters

Parameter	Type
listener	(eventName, payload) => void

Returns

EventUnsubscribe

---

Once()

Once<K>(
   eventName, 
   listener, 
   context?
): EventUnsubscribe;

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

Parameter	Type
eventName	K
listener	EventListener<EventMap[K]>
context?	object

Returns

EventUnsubscribe