Class AsyncTaskQueue

Runs asynchronous tasks with a limited concurrency, queueing anything that doesn't fit and optionally waiting a delay between dequeued batches.

Index

Constructors

Accessors

activeTasks pendingTasks

Methods

addTask clear dequeue

Constructors

constructor

new AsyncTaskQueue(options?: AsyncTaskQueueOptions): AsyncTaskQueue
Parameters
- options: AsyncTaskQueueOptions = {}
Returns AsyncTaskQueue
- Defined in packages/viewer/src/utils/AsyncTaskQueue.ts:51

Accessors

activeTasks

get activeTasks(): number
Number of active tasks

Returns number
- Defined in packages/viewer/src/utils/AsyncTaskQueue.ts:59

pendingTasks

get pendingTasks(): number
Number of tasks in the queue

Returns number
- Defined in packages/viewer/src/utils/AsyncTaskQueue.ts:66

Methods

addTask

addTask<T>(task: AsyncTask<T>, autoDequeue?: boolean): Promise<T>
Adds a new task to the queue
Type Parameters
- T
Parameters
- task: AsyncTask<T>
- autoDequeue: boolean = false
Returns Promise<T>
- Defined in packages/viewer/src/utils/AsyncTaskQueue.ts:75

clear

clear(): void
Removes the tasks in the queue and rejects them

Returns void
- Defined in packages/viewer/src/utils/AsyncTaskQueue.ts:130

dequeue

dequeue(autoDequeue?: boolean): void
Dequeues tasks.
- If autoDequeue is false, it just tries to fill concurrency once.
- If autoDequeue is true, finished tasks will schedule mext tasks.
Parameters
- autoDequeue: boolean = false
Returns void
- Defined in packages/viewer/src/utils/AsyncTaskQueue.ts:99