Skip to main content
Version: 1.x

AsyncQueueOptions

AsyncQueueOptions​

commandkitasync-queue.ts

Async queue implementation for processing tasks sequentially or with limited concurrency. Useful for rate-limiting, batching, or controlling resource usage.

Signature
interface AsyncQueueOptions {
    concurrency?: number;
    onDrain?: () => void | Promise<void>;
    signal?: AbortSignal;
}

concurrency​

property
number

Maximum number of concurrent tasks. Default: 1 (sequential)

onDrain​

property
() => void | Promise<void>

Optional callback invoked when all tasks are completed

signal​

property
AbortSignal

Optional AbortSignal for cancelling the queue