# Class TaskQueue

## TaskQueue 任务队列管理

#### Hierarchy

- TaskQueue

- Defined in src/taskQueue.ts:32

#####
Index

### Constructors

constructor

### Properties

AllowedRetrySystemErrorCodes
AllowedRetrySystemErrorMessages
AllowedRetrySystemErrorNames
DelayRetryTime
ExecuteTaskTime
MaxExecuteTask
MaxKeepLiveSuccessTask
MaxRetry
emitter
failTaskQueue
processingTaskQueue
readyTaskQueue
successTaskQueue

### Methods

createTask
findPreConditionTaskChildTasks
getIdleTaskQuantity
getPreConditionTaskOnProcessing
getProcessingTaskQueueExecutableTasks
getReadyTaskQueueByLevelSort
getReadyTaskQueueExecutableTasks
init
startFailTaskQueue
startProcessingTaskQueue
startReadyTaskQueue
startSuccessTaskQueue

## Constructors

### constructor

- new TaskQueue(config?: TaskQueueConfig): TaskQueue

- #### Parameters

  - ##### `Optional` config: TaskQueueConfig

  #### Returns TaskQueue

  - Defined in src/taskQueue.ts:62

## Properties

### `Readonly` AllowedRetrySystemErrorCodes

AllowedRetrySystemErrorCodes: number[] = []

需要处理的系统错误 当错误信息匹配的时候 才会进入重试task流程 否则任务不会重试 即任务重试需要满足两个条件：报错+报错信息匹配 *

- Defined in src/taskQueue.ts:60

### `Readonly` AllowedRetrySystemErrorMessages

AllowedRetrySystemErrorMessages: string[] = []

需要处理的系统错误 当错误信息匹配的时候 才会进入重试task流程 否则任务不会重试 即任务重试需要满足两个条件：报错+报错信息匹配 *

- Defined in src/taskQueue.ts:58

### `Readonly` AllowedRetrySystemErrorNames

AllowedRetrySystemErrorNames: string[] = []

需要处理的系统错误 当错误信息匹配的时候 才会进入重试task流程 否则任务不会重试 即任务重试需要满足两个条件：报错+报错信息匹配 *

- Defined in src/taskQueue.ts:56

### `Readonly` DelayRetryTime

DelayRetryTime: number = 1888

延迟重试时间 单位：毫秒 *

- Defined in src/taskQueue.ts:51

### `Readonly` ExecuteTaskTime

ExecuteTaskTime: number = 888

执行任务的单位时间 *

- Defined in src/taskQueue.ts:45

### `Readonly` MaxExecuteTask

MaxExecuteTask: number = 8

最大可执行的任务数量 *

- Defined in src/taskQueue.ts:47

### `Readonly` MaxKeepLiveSuccessTask

MaxKeepLiveSuccessTask: number = 0

最大保存的执行成功任务数量 *

- Defined in src/taskQueue.ts:53

### `Readonly` MaxRetry

MaxRetry: number = 8

最大重试次数 *

- Defined in src/taskQueue.ts:49

### `Readonly` emitter

emitter: Emitter<any> = ...

- Defined in src/taskQueue.ts:33

### `Readonly` failTaskQueue

failTaskQueue: Map<string, Task> = ...

失败的任务队列 *

- Defined in src/taskQueue.ts:42

### `Readonly` processingTaskQueue

processingTaskQueue: Map<string, Task> = ...

处理中的任务队列 *

- Defined in src/taskQueue.ts:38

### `Readonly` readyTaskQueue

readyTaskQueue: Map<string, Task> = ...

已经准备好的任务队列 *

- Defined in src/taskQueue.ts:36

### `Readonly` successTaskQueue

successTaskQueue: Map<string, Task> = ...

执行成功的任务队列 *

- Defined in src/taskQueue.ts:40

## Methods

### createTask

- createTask(data: CreateTaskParams): Promise<any>

- 创建任务 *

  #### Parameters

  - ##### data: CreateTaskParams

  #### Returns Promise<any>

  - Defined in src/taskQueue.ts:242

### `Private` findPreConditionTaskChildTasks

- findPreConditionTaskChildTasks(parentTaskId: string): Promise<Task[]>

- #### Parameters

  - ##### parentTaskId: string

  #### Returns Promise<Task[]>

  - Defined in src/taskQueue.ts:190

### `Private` getIdleTaskQuantity

- getIdleTaskQuantity(): Promise<number>

- 处理队列空闲任务数量 *

  #### Returns Promise<number>

  - Defined in src/taskQueue.ts:225

### `Private` getPreConditionTaskOnProcessing

- getPreConditionTaskOnProcessing(): Promise<undefined | Task>

- #### Returns Promise<undefined | Task>

  - Defined in src/taskQueue.ts:185

### `Private` getProcessingTaskQueueExecutableTasks

- getProcessingTaskQueueExecutableTasks(): Promise<Task[]>

- 返回状态为ready的即将执行的任务(执行队列中) *

  #### Returns Promise<Task[]>

  - Defined in src/taskQueue.ts:137

### `Private` getReadyTaskQueueByLevelSort

- getReadyTaskQueueByLevelSort(): Promise<Task[]>

- 返回按照level排序的任务 *

  #### Returns Promise<Task[]>

  - Defined in src/taskQueue.ts:180

### `Private` getReadyTaskQueueExecutableTasks

- getReadyTaskQueueExecutableTasks(): Promise<Task[]>

- 返回状态为ready的准备执行的任务(准备队列中) *

  #### Returns Promise<Task[]>

  - Defined in src/taskQueue.ts:196

### `Private` init

- init(): void

- 队列初始化 *

  #### Returns void

  - Defined in src/taskQueue.ts:88

### `Private` startFailTaskQueue

- startFailTaskQueue(task: Task): Promise<void>

- 开始处理失败的队列 *

  #### Parameters

  - ##### task: Task

  #### Returns Promise<void>

  - Defined in src/taskQueue.ts:121

### `Private` startProcessingTaskQueue

- startProcessingTaskQueue(): Promise<void>

- 开始执行任务 *

  #### Returns Promise<void>

  - Defined in src/taskQueue.ts:143

### `Private` startReadyTaskQueue

- startReadyTaskQueue(): Promise<void>

- 开始处理准备阶段的任务队列 *

  #### Returns Promise<void>

  - Defined in src/taskQueue.ts:230

### `Private` startSuccessTaskQueue

- startSuccessTaskQueue(task: Task): Promise<void>

- 开始处理成功的队列 *

  #### Parameters

  - ##### task: Task

  #### Returns Promise<void>

  - Defined in src/taskQueue.ts:110

Generated using TypeDoc