Class EventQue<E>

EventQue - A type-safe, async-friendly, queue-based event emitter.

Features:

Async emit with Promise results
Queueing to guarantee order of emits
Parallel or sequential listener execution
Per-listener timeout with AbortSignal cancellation
Event-specific default options
Compatible with Node.js EventEmitter (on, once, off)

Type Parameters

E extends EventMap

Index

Constructors

Methods

emitAsync off on once

Constructors

constructor

new EventQue<E extends EventMap>(config?: EventQConfig<E>): EventQue<E>
Type Parameters
- E extends EventMap
Parameters
- Optionalconfig: EventQConfig<E>
Returns EventQue<E>
- Defined in EventQue.ts:75

Methods

emitAsync

emitAsync<K extends string | number | symbol>(
event: K,
...argsAndMaybeOptions: [...E[K][], EmitOptions?],
): Promise<EmitResult<E[K]>[]>
Emit an event asynchronously, returning a Promise of all listener results. The call is queued to ensure order of emits.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- ...argsAndMaybeOptions: [...E[K][], EmitOptions?]
Returns Promise<EmitResult<E[K]>[]>
- Defined in EventQue.ts:106

off

off<K extends string | number | symbol>(
event: K,
listener: Listener<E[K]>,
): void
Remove a registered listener.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: Listener<E[K]>
Returns void
- Defined in EventQue.ts:98

on

on<K extends string | number | symbol>(event: K, listener: Listener<E[K]>): void
Register a listener for the given event. The listener must accept AbortSignal as the last parameter.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: Listener<E[K]>
Returns void
- Defined in EventQue.ts:84

once

once<K extends string | number | symbol>(
event: K,
listener: Listener<E[K]>,
): void
Register a listener that runs only once.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: Listener<E[K]>
Returns void
- Defined in EventQue.ts:91