@vgerbot/async
    Preparing search index...

    Interface TaskQueue<T, R>

    Concurrency-limited async task queue.

    The queue accepts tasks (push) and processes them with the configured worker while respecting concurrency. It supports pause/resume, cancellation, and idle notifications.

    Cancellation semantics:

    • Pending tasks are rejected with CancelError.
    • Running tasks receive a cancelled token and may stop if they honor it.
    interface TaskQueue<T, R> {
        idle: boolean;
        length: number;
        paused: boolean;
        running: number;
        cancel(reason?: unknown): void;
        isCancelled(): boolean;
        onEmpty(): Promise<void>;
        onError(): Promise<QueueTaskError<T>>;
        onIdle(): Promise<void>;
        onSaturated(): Promise<void>;
        onSizeLessThan(size: number): Promise<void>;
        pause(): void;
        push(task: T): Promise<R>;
        pushMany(tasks: T[]): Promise<R[]>;
        resume(): void;
    }

    Type Parameters

    • T
    • R
    Index

    Properties

    idle length paused running

    Methods

    cancel isCancelled onEmpty onError onIdle onSaturated onSizeLessThan pause push pushMany resume

    Properties

    idle: boolean

    True when both length and running are zero.

    length: number

    Number of queued tasks waiting to be processed.

    paused: boolean

    True when scheduling is paused.

    running: number

    Number of tasks currently executing.

    Methods

    • Resolves when queued task count becomes less than the provided threshold.

      Parameters

      • size: number

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods