Class TaskQueue

Task queue with concurrency control. By default, all added tasks will be auto scheduled and executed. You can use stop() and start() to control the execution.

Hierarchy

TaskQueueBase
- TaskQueue

Constructors

constructor

new TaskQueue(props?): TaskQueue
Parameters
- props: TaskQueueProps = {}
Returns TaskQueue
Overrides TaskQueueBase.constructor
- Defined in index.ts:32

Properties

`Protected` `Internal` concurrency

concurrency: number

`Protected` `Internal` defaultIncrementalTaskId

defaultIncrementalTaskId: boolean

`Protected` `Internal` failedRetryableTaskQueue

failedRetryableTaskQueue: Task<any>[] = []

`Protected` `Internal` logger

logger: ILogger

`Protected` `Internal` memorizeTasks

memorizeTasks: boolean

`Private` messageHub

messageHub: MessageHub

`Protected` `Internal` onTaskStatusUpdate

onTaskStatusUpdate: undefined | TaskStatusUpdateHandler<any> = undefined

`Protected` `Internal` prioritizedTasksWaitingQueue

prioritizedTasksWaitingQueue: WaitedTask<any>[] = []

`Protected` `Internal` promiseQueueCapacity

promiseQueueCapacity: number = PROMISE_QUEUE_CAPACITY

`Protected` `Internal` promiseQueues

promiseQueues: PromiseQueue[] = []

`Protected` `Internal` retrying

retrying: boolean = false

`Protected` `Internal` stopOnError

stopOnError: boolean

`Protected` `Internal` stopped

stopped: boolean = false

`Protected` `Internal` taskLookup

taskLookup: Record<TaskId, Task<any>> = {}

`Protected` `Internal` taskPrioritizationMode

taskPrioritizationMode: TaskPrioritizationMode

`Protected` `Internal` tasksWaitingQueue

tasksWaitingQueue: WaitedTask<any>[] = []

Methods

`Protected` _addTask

_addTask<ReturnType>(task, withTaskClean?): Promise<ReturnType>
Internal
Type Parameters
- ReturnType
Parameters
- task: Task<ReturnType> | WaitedTask<ReturnType>
- withTaskClean: boolean = true
Returns Promise<ReturnType>
Inherited from TaskQueueBase._addTask
- Defined in core.ts:287

`Private` _assertMemorizingTasksEnabled

_assertMemorizingTasksEnabled(): void
Internal
Returns void
- Defined in index.ts:275

`Protected` _cleanTask

_cleanTask<TaskType>(task): TaskType
Internal
Type Parameters
- TaskType extends WaitedTask<any> | Task<any>
Parameters
- task: TaskType
Returns TaskType
Inherited from TaskQueueBase._cleanTask
- Defined in core.ts:273

`Protected` _createTask

_createTask<ReturnType>(callback, taskId?, onStatusUpdate?, priority?): {
    callback: (() => ReturnType | Promise<ReturnType>);
    createdAt: number;
    onStatusUpdate: undefined | TaskStatusUpdateHandler<ReturnType>;
    priority: TaskPriority;
    status: TaskStatus;
    taskId: TaskId;
}
Internal
Type Parameters
- ReturnType
Parameters
- callback: (() => ReturnType | Promise<ReturnType>)
  - - (): ReturnType | Promise<ReturnType>
    - Returns ReturnType | Promise<ReturnType>
- Optional taskId: TaskId
- Optional onStatusUpdate: TaskStatusUpdateHandler<ReturnType>
- priority: TaskPriority = 'normal'
Returns {
    callback: (() => ReturnType | Promise<ReturnType>);
    createdAt: number;
    onStatusUpdate: undefined | TaskStatusUpdateHandler<ReturnType>;
    priority: TaskPriority;
    status: TaskStatus;
    taskId: TaskId;
}
- callback: (() => ReturnType | Promise<ReturnType>)
  - - (): ReturnType | Promise<ReturnType>
    - Returns ReturnType | Promise<ReturnType>
- createdAt: number
- onStatusUpdate: undefined | TaskStatusUpdateHandler<ReturnType>
- priority: TaskPriority
- status: TaskStatus
- taskId: TaskId
Inherited from TaskQueueBase._createTask
- Defined in base.ts:234

`Protected` _getAvailablePromiseQueue

_getAvailablePromiseQueue(): null | PromiseQueue
Internal
Returns null | PromiseQueue
Inherited from TaskQueueBase._getAvailablePromiseQueue
- Defined in base.ts:96

`Protected` _getNextTask

_getNextTask(previousTaskHasRun): undefined | null | Task<any>
Internal
Parameters
- previousTaskHasRun: boolean
Returns undefined | null | Task<any>
Inherited from TaskQueueBase._getNextTask
- Defined in base.ts:129

`Protected` _log

_log(config, ...messages): void
Internal
Parameters
- config: {
  level: LoggerMethodNames;
  taskId?: TaskId;
  }
  - level: LoggerMethodNames
  - Optional taskId?: TaskId
- Rest ...messages: any[]
Returns void
Inherited from TaskQueueBase._log
- Defined in core.ts:216

`Protected` _pushTaskToWaitingQueue

_pushTaskToWaitingQueue(task): void
Internal
Parameters
- task: WaitedTask<any>
Returns void
Inherited from TaskQueueBase._pushTaskToWaitingQueue
- Defined in base.ts:106

`Protected` _shouldStop

_shouldStop(task?): boolean
Internal
Parameters
- Optional task: Task<any>
Returns boolean
Inherited from TaskQueueBase._shouldStop
- Defined in base.ts:201

addPrioritizedTask

addPrioritizedTask<ReturnType>(callback): Promise<ReturnType>
Add a task with callback function to the prioritized queue.
Type Parameters
- ReturnType
Parameters
- callback: (() => ReturnType | Promise<ReturnType>)
  The callback function of the task
  - - (): ReturnType | Promise<ReturnType>
    - Returns ReturnType | Promise<ReturnType>
Returns Promise<ReturnType>
- Defined in index.ts:115
addPrioritizedTask<ReturnType>(callback, onStatusUpdate?): Promise<ReturnType>
Add a task with callback function to the prioritized queue.
Type Parameters
- ReturnType
Parameters
- callback: (() => ReturnType | Promise<ReturnType>)
  The callback function of the task
  - - (): ReturnType | Promise<ReturnType>
    - Returns ReturnType | Promise<ReturnType>
- Optional onStatusUpdate: TaskStatusUpdateHandler<ReturnType>
  The callback function to subscribe task status changes
Returns Promise<ReturnType>
- Defined in index.ts:125
addPrioritizedTask<ReturnType>(callback, taskId?, onStatusUpdate?): Promise<ReturnType>
Add a task with callback function to the prioritized queue.
Type Parameters
- ReturnType
Parameters
- callback: (() => ReturnType | Promise<ReturnType>)
  The callback function of the task
  - - (): ReturnType | Promise<ReturnType>
    - Returns ReturnType | Promise<ReturnType>
- Optional taskId: TaskId
  The ID of the task
- Optional onStatusUpdate: TaskStatusUpdateHandler<ReturnType>
  The callback function to subscribe task status changes
Returns Promise<ReturnType>
- Defined in index.ts:137

addTask

addTask<ReturnType>(callback): Promise<ReturnType>
Add a task with callback function to the queue.
Type Parameters
- ReturnType
Parameters
- callback: (() => ReturnType | Promise<ReturnType>)
  The callback function of the task
  - - (): ReturnType | Promise<ReturnType>
    - Returns ReturnType | Promise<ReturnType>
Returns Promise<ReturnType>
- Defined in index.ts:63
addTask<ReturnType>(callback, onStatusUpdate?): Promise<ReturnType>
Add a task with callback function to the queue.
Type Parameters
- ReturnType
Parameters
- callback: (() => ReturnType | Promise<ReturnType>)
  The callback function of the task
  - - (): ReturnType | Promise<ReturnType>
    - Returns ReturnType | Promise<ReturnType>
- Optional onStatusUpdate: TaskStatusUpdateHandler<ReturnType>
  The callback function to subscribe task status changes
Returns Promise<ReturnType>
- Defined in index.ts:73
addTask<ReturnType>(callback, taskId?, onStatusUpdate?): Promise<ReturnType>
Add a task with callback function to the queue.
Type Parameters
- ReturnType
Parameters
- callback: (() => ReturnType | Promise<ReturnType>)
  The callback function of the task
  - - (): ReturnType | Promise<ReturnType>
    - Returns ReturnType | Promise<ReturnType>
- Optional taskId: TaskId
  The ID of the task
- Optional onStatusUpdate: TaskStatusUpdateHandler<ReturnType>
  The callback function to subscribe task status changes
Returns Promise<ReturnType>
- Defined in index.ts:85

addTasks

addTasks(tasks): Promise<unknown[]>
Add tasks with callback functions to the queue.
Parameters
- tasks: {
      callback: (() => unknown);
      onStatusUpdate?: TaskStatusUpdateHandler<unknown>;
      priority?: TaskPriority;
      taskId?: TaskId;
  }[]
  The array of tasks with callback functions, IDs, task status update subscribers, and priorities
Returns Promise<unknown[]>
- Defined in index.ts:178

adjustConcurrency

adjustConcurrency(newConcurrency, taskBalancingStrategy?): void
Adjust the concurrency.
Parameters
- newConcurrency: number
  The new concurrency
- taskBalancingStrategy: "round-robin" = 'round-robin'
  The existing running task balancing strategy
Returns void
Inherited from TaskQueueBase.adjustConcurrency
- Defined in core.ts:111

clearAllTasksDetails

clearAllTasksDetails(): void
Clear all task details.

Returns void
- Defined in index.ts:324

clearFailedRetryableTasks

clearFailedRetryableTasks(): void
Clear all failed retryable tasks from the queue.

Returns void
- Defined in index.ts:245

clearTaskDetails

clearTaskDetails(taskId): void
Clear the task details with task ID.
Parameters
- taskId: TaskId
  The ID of the task
Returns void
- Defined in index.ts:313

clearWaitedTasks

clearWaitedTasks(): void
Clear all waited tasks from the queue.

Returns void
- Defined in index.ts:208

getAllTasksDetails

getAllTasksDetails(status?): Task<any>[]
Get all task details with optional matching status.
Parameters
- Optional status: TaskStatus | TaskStatus[]
  The matched status or array of statuses
Returns Task<any>[]
- Defined in index.ts:295

getConcurrency

getConcurrency(): number
Get the current concurrency of the queue

Returns number
Inherited from TaskQueueBase.getConcurrency
- Defined in core.ts:211

getTaskDetails

getTaskDetails(taskId): Task<any>
Get the task details with task ID.
Parameters
- taskId: TaskId
  The ID of the task
Returns Task<any>
- Defined in index.ts:285

isManuallyStopped

isManuallyStopped(): boolean
Check if the queue is manually stopped.

Returns boolean
Inherited from TaskQueueBase.isManuallyStopped
- Defined in base.ts:335

removeFailedRetryableTask

removeFailedRetryableTask(taskIdOrTask): void
Remove the task from failed retryable task queue.
Parameters
- taskIdOrTask: TaskId | Task<any>
  The ID of the task or task object
Returns void
- Defined in index.ts:258

removeWaitedTask

removeWaitedTask(taskIdOrTask): void
Remove the task from waited task queue.
Parameters
- taskIdOrTask: TaskId | Task<any>
  The ID of the task or task object
Returns void
- Defined in index.ts:222

retry

retry(): void
Retry running the queue with failed tasks. Please note, this method will be effective only when marking "stopOnError" as "true" for the queue.

Returns void
Inherited from TaskQueueBase.retry
- Defined in base.ts:306

start

start(): void
Start the queue execution.

Returns void
Inherited from TaskQueueBase.start
- Defined in base.ts:261

stop

stop(): void
Stop the queue execution. Please note, the current ongoing task will not be stopped immediately.

Returns void
Inherited from TaskQueueBase.stop
- Defined in base.ts:290

subscribeTaskStatusChange

subscribeTaskStatusChange(onTaskStatusUpdate): (() => void)
Subscribe to the task status changes.
Parameters
- onTaskStatusUpdate: TaskStatusUpdateHandler<any>
  The listener for task status updates
Returns (() => void)
- - (): void
  - Returns void
- Defined in index.ts:46

unsubscribeTaskStatusChange

unsubscribeTaskStatusChange(onTaskStatusUpdate): void
Unsubscribe from the task status changes.
Parameters
- onTaskStatusUpdate: TaskStatusUpdateHandler<any>
  The listener for task status updates
Returns void
- Defined in index.ts:55

Class TaskQueue

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TaskQueue

Properties

Protected Internal concurrency

Protected Internal defaultIncrementalTaskId

Protected Internal failedRetryableTaskQueue

Protected Internal logger

Protected Internal memorizeTasks

Private messageHub

Protected Internal onTaskStatusUpdate

Protected Internal prioritizedTasksWaitingQueue

Protected Internal promiseQueueCapacity

Protected Internal promiseQueues

Protected Internal retrying

Protected Internal stopOnError

Protected Internal stopped

Protected Internal taskLookup

Protected Internal taskPrioritizationMode

Protected Internal tasksWaitingQueue

Methods

Protected _addTask

Type Parameters

Parameters

Returns Promise<ReturnType>

Private _assertMemorizingTasksEnabled

Returns void

Protected _cleanTask

Type Parameters

Parameters

Returns TaskType

Protected _createTask

Type Parameters

Parameters

Returns ReturnType | Promise<ReturnType>

Returns { callback: (() => ReturnType | Promise<ReturnType>); createdAt: number; onStatusUpdate: undefined | TaskStatusUpdateHandler<ReturnType>; priority: TaskPriority; status: TaskStatus; taskId: TaskId; }

callback: (() => ReturnType | Promise<ReturnType>)

Returns ReturnType | Promise<ReturnType>

createdAt: number

onStatusUpdate: undefined | TaskStatusUpdateHandler<ReturnType>

priority: TaskPriority

status: TaskStatus

taskId: TaskId

Protected _getAvailablePromiseQueue

Returns null | PromiseQueue

Protected _getNextTask

Parameters

Returns undefined | null | Task<any>

Protected _log

Parameters

level: LoggerMethodNames

Optional taskId?: TaskId

Returns void

Protected _pushTaskToWaitingQueue

Parameters

Returns void

Protected _shouldStop

Parameters

Returns boolean

addPrioritizedTask

Type Parameters

Parameters

Returns ReturnType | Promise<ReturnType>

Returns Promise<ReturnType>

Type Parameters

Parameters

Returns ReturnType | Promise<ReturnType>

Returns Promise<ReturnType>

Type Parameters

Parameters

Returns ReturnType | Promise<ReturnType>

Returns Promise<ReturnType>

addTask

`Protected` `Internal` concurrency

`Protected` `Internal` defaultIncrementalTaskId

`Protected` `Internal` failedRetryableTaskQueue

`Protected` `Internal` logger

`Protected` `Internal` memorizeTasks

`Private` messageHub

`Protected` `Internal` onTaskStatusUpdate

`Protected` `Internal` prioritizedTasksWaitingQueue

`Protected` `Internal` promiseQueueCapacity

`Protected` `Internal` promiseQueues

`Protected` `Internal` retrying

`Protected` `Internal` stopOnError

`Protected` `Internal` stopped

`Protected` `Internal` taskLookup

`Protected` `Internal` taskPrioritizationMode

`Protected` `Internal` tasksWaitingQueue

`Protected` _addTask

`Private` _assertMemorizingTasksEnabled

`Protected` _cleanTask

`Protected` _createTask

Returns {
callback: (() => ReturnType | Promise<ReturnType>);
createdAt: number;
onStatusUpdate: undefined | TaskStatusUpdateHandler<ReturnType>;
priority: TaskPriority;
status: TaskStatus;
taskId: TaskId;
}

`Protected` _getAvailablePromiseQueue

`Protected` _getNextTask

`Protected` _log

`Optional` taskId?: TaskId

`Protected` _pushTaskToWaitingQueue

`Protected` _shouldStop