Class AsyncFifoQueue<T>

AsyncFifoQueue

A minimal FIFO queue for asynchronous operations. Allows adding asynchronous operations and consume them in the order they are resolved.

Type Parameters

T

Index

Constructors

Methods

add fetch numPending numQueued numTotal waitAll

Constructors

constructor

new AsyncFifoQueue<T>(ignoreErrors?: boolean): AsyncFifoQueue<T>
Type Parameters
- T
Parameters
- ignoreErrors: boolean = false
Returns AsyncFifoQueue<T>
- Defined in classes/async-fifo-queue.ts:79

Methods

add

add(promise: Promise<T>): void
Adds a promise to the queue. When it resolves, its value is enqueued and, if a consumer is waiting via fetch, the next pending promise is resolved with the value.
Parameters
- promise: Promise<T>
  The asynchronous operation to add to the queue.
Returns void
- Defined in classes/async-fifo-queue.ts:90

fetch

fetch(): Promise<void | T>
Fetches the next resolved item from the queue in FIFO order. If no items are currently resolved but pending promises exist, it waits until the next one resolves.

Returns Promise<void | T>
The next resolved value, or undefined if there are no pending or queued items.
- Defined in classes/async-fifo-queue.ts:180

numPending

numPending(): number
Returns the number of promises that are still pending (in-flight).

Returns number
The number of unresolved promises currently in the queue.
- Defined in classes/async-fifo-queue.ts:137

numQueued

numQueued(): number
Returns the number of items that have already resolved but have not yet been fetched by a consumer.

Returns number
The number of resolved items waiting to be consumed.
- Defined in classes/async-fifo-queue.ts:147

numTotal

numTotal(): number
Returns the total number of items currently tracked by the queue, including both pending (in-flight) promises and resolved items that have not yet been fetched.

Returns number
The sum of pending and queued items.
- Defined in classes/async-fifo-queue.ts:128

waitAll

waitAll(): Promise<void>
Waits for all currently pending promises to settle.

Returns Promise<void>
A promise that resolves once every in-flight promise has resolved.
- Defined in classes/async-fifo-queue.ts:117