Class AsyncTaskQueue

Index

Constructors

Accessors

activeTasks pendingTasks

Methods

addTask clear dequeue

Constructors

constructor

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

Accessors

activeTasks

get activeTasks(): number
Number of active tasks

Returns number
- Defined in src/utils/AsyncTaskQueue.ts:37

pendingTasks

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

Returns number
- Defined in src/utils/AsyncTaskQueue.ts:44

Methods

addTask

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

clear

clear(): void
Removes the tasks in the queue

Returns void
- Defined in src/utils/AsyncTaskQueue.ts:92

dequeue

dequeue(autoDequeue?: boolean): Promise<void>
Dequeues only the first task if autoDequeue is false, otherwise dequeues all the tasks in respect of concurrency.
Parameters
- autoDequeue: boolean = false
  Whether to automatically dequeue
Returns Promise<void>
Default
```
false
```
- Defined in src/utils/AsyncTaskQueue.ts:68