Class Queue

constructor

• new Queue(options?: QueueOptions): Queue

  Creates a queue with optional status notification callback and error pausing behavior.

  Parameters

  • options: QueueOptions = {}

  Returns Queue

OptionalonStatusChange

isCancelled

• get isCancelled(): boolean

  True after cancellation has been requested.

  Returns boolean

isIdle

• get isIdle(): boolean

  True when there is no runner and no pending work.

  Returns boolean

isPaused

• get isPaused(): boolean

  True when processing is paused.

  Returns boolean

isProcessing

• get isProcessing(): boolean

  True when the queue is actively processing tasks.

  Returns boolean

lastTaskError

• get lastTaskError(): Error | null

  Captured error from the last failed task when pause-on-error is enabled.

  Returns Error | null

size

• get size(): number

  Number of tasks waiting to be processed.

  Returns number

status

• get status(): QueueStatus

  Current processing status of the queue.

  Returns QueueStatus

addNextTask

• addNextTask(task: () => Promise<void>): void

  Enqueues a task to run next (ahead of other pending tasks) without preempting the current task.

  Parameters

  • task: () => Promise<void>

  Returns void

addTask

• addTask(task: () => Promise<void>): void

  Enqueues a new task and starts processing if idle, resurrecting a cancelled queue.

  Parameters

  • task: () => Promise<void>

  Returns void

cancelQueue

• cancelQueue(): void

  Cancels all pending work, clears the queue, and prevents further status flips from stale runners.

  Returns void

clearLastError

• clearLastError(): void

  Clears the stored lastTaskError value.

  Returns void

clearQueue

• clearQueue(): void

  Removes all pending tasks without altering status when processing or paused.

  Returns void

pauseQueue

• pauseQueue(): void

  Pauses processing after the current task completes.

  Returns void

resumeQueue

• resumeQueue(): void

  Resumes processing, clearing any stored error when leaving a paused state.

  Returns void