API reference / @node-ts/bus-core / TypedEmitter

Class: TypedEmitter<T>

Defined in: packages/bus-core/src/util/typed-emitter.ts:19

An EventEmitter that emits a strongly typed event.

Listeners are invoked synchronously. A listener that returns a promise isn't awaited, but its rejection is caught and passed to onListenerRejected instead of becoming an unhandled rejection.

See

https://basarat.gitbook.io/typescript/main-1/typed-event

Type Parameters

Type Parameter
T

Constructors

Constructor

new TypedEmitter<T>(onListenerRejected?): TypedEmitter<T>;

Defined in: packages/bus-core/src/util/typed-emitter.ts:26

Parameters

Parameter	Type	Description
onListenerRejected?	ListenerRejectedHandler	Called when an async listener rejects. When not provided, rejections are ignored.

Returns

TypedEmitter<T>

Methods

emit()

emit(event): void;

Defined in: packages/bus-core/src/util/typed-emitter.ts:42

Parameters

Parameter	Type
event	T

Returns

void

---

off()

off(listener): void;

Defined in: packages/bus-core/src/util/typed-emitter.ts:37

Parameters

Parameter	Type
listener	Listener<T>

Returns

void

---

on()

on(listener): Unsubscribe;

Defined in: packages/bus-core/src/util/typed-emitter.ts:28

Parameters

Parameter	Type
listener	Listener<T>

Returns

Unsubscribe

---

once()

once(listener): void;

Defined in: packages/bus-core/src/util/typed-emitter.ts:33

Parameters

Parameter	Type
listener	Listener<T>

Returns

void

---

pipe()

pipe(typedEmitter): Unsubscribe;

Defined in: packages/bus-core/src/util/typed-emitter.ts:54

Parameters

Parameter	Type
typedEmitter	TypedEmitter<T>

Returns

Unsubscribe