Class Queue

Cooperative task queue. • Tasks run one‑after‑another (FIFO ordering). • Dead‑lock detection prevents nesting. • dispose() drains or cancels outstanding tasks, then rejects new ones.

Index

Constructors

Methods

dispose isIdle on once run

Constructors

constructor

new Queue(): Queue

Returns Queue

Methods

dispose

dispose(options?: { cancel?: boolean }): Promise<void>
Disposes the queue.
Parameters
- options: { cancel?: boolean } = {}
  - Optionalcancel?: boolean
    
    – if true, broadcasts AbortSignal to running task. default: false (waits for tasks to finish).
Returns Promise<void>
- Defined in src/models/Queue.ts:134

isIdle

isIdle(): boolean
Returns boolean
- Defined in src/models/Queue.ts:205

on

on(type: QueueEventType, handler: (event: QueueEvent) => any): () => void
Parameters
- type: QueueEventType
- handler: (event: QueueEvent) => any
Returns () => void
- Defined in src/models/Queue.ts:153

once

once(type: QueueEventType, handler: (event: QueueEvent) => any): () => void
Parameters
- type: QueueEventType
- handler: (event: QueueEvent) => any
Returns () => void
- Defined in src/models/Queue.ts:178

run

run<T>(task: (signal: AbortSignal) => Promise<T>): Promise<T>
Schedule an asynchronous task.
Type Parameters
- T
Parameters
- task: (signal: AbortSignal) => Promise<T>
  – receives an AbortSignal so it can cancel early if desired.
Returns Promise<T>
- Defined in src/models/Queue.ts:64