Skip to content

Class TaskGroup

🏭 Constructors

constructor

ts
new TaskGroup(): TaskGroup<T>

Return Type

  • TaskGroup<T>

Inherited from: BaseTask.constructor

Defined in: packages/task/index.ts:95

🏷️ Properties

_from

ts
_from: undefined | string

Inherited from: BaseTask._from

Defined in: packages/task/index.ts:80

_id

ts
_id: number = 0

Inherited from: BaseTask._id

Defined in: packages/task/index.ts:85

_path

ts
_path: string = ''

Inherited from: BaseTask._path

Defined in: packages/task/index.ts:84

_progress

ts
_progress: number = 0

Inherited from: BaseTask._progress

Defined in: packages/task/index.ts:82

_promise

ts
_promise: Promise<T>

Inherited from: BaseTask._promise

Defined in: packages/task/index.ts:75

_state

ts
_state: TaskState = TaskState.Idle

Inherited from: BaseTask._state

Defined in: packages/task/index.ts:74

_to

ts
_to: undefined | string

Inherited from: BaseTask._to

Defined in: packages/task/index.ts:81

_total

ts
_total: number = -1

Inherited from: BaseTask._total

Defined in: packages/task/index.ts:83

children

ts
children: Task<any>[] = []

Defined in: packages/task/index.ts:285

context

ts
context: TaskContext = {}

Inherited from: BaseTask.context

Defined in: packages/task/index.ts:88

name

ts
name: string = ''

Inherited from: BaseTask.name

Defined in: packages/task/index.ts:90

param

ts
param: object = {}

Inherited from: BaseTask.param

Defined in: packages/task/index.ts:91

parent

ts
parent: undefined | Task<any>

Inherited from: BaseTask.parent

Defined in: packages/task/index.ts:87

reject

ts
reject: Function

Inherited from: BaseTask.reject

Defined in: packages/task/index.ts:78

resolve

ts
resolve: Function

Inherited from: BaseTask.resolve

Defined in: packages/task/index.ts:77

resultOrError

ts
resultOrError: any

Inherited from: BaseTask.resultOrError

Defined in: packages/task/index.ts:93

🔑 Accessors

from

Inherited from: BaseTask.from

Defined in: packages/task/index.ts:121

id

Inherited from: BaseTask.id

Defined in: packages/task/index.ts:116

isCancelled

Inherited from: BaseTask.isCancelled

Defined in: packages/task/index.ts:124

isDone

Inherited from: BaseTask.isDone

Defined in: packages/task/index.ts:126

isPaused

Inherited from: BaseTask.isPaused

Defined in: packages/task/index.ts:125

isRunning

Inherited from: BaseTask.isRunning

Defined in: packages/task/index.ts:127

path

Inherited from: BaseTask.path

Defined in: packages/task/index.ts:117

progress

Inherited from: BaseTask.progress

Defined in: packages/task/index.ts:118

state

Inherited from: BaseTask.state

Defined in: packages/task/index.ts:122

to

Inherited from: BaseTask.to

Defined in: packages/task/index.ts:120

total

Inherited from: BaseTask.total

Defined in: packages/task/index.ts:119

🔧 Methods

all

ts
all(tasks: Iterable<T>, __namedParameters: Object= ...): Promise<(T extends Task<R> ? R : never)[]>

Parameters

  • tasks: Iterable<T>
  • __namedParameters: Object

Return Type

  • Promise<(T extends Task<R> ? R : never)[]>

Defined in: packages/task/index.ts:311

cancel

ts
cancel(timeout: number): Promise<void>

Parameters

  • timeout: number

Return Type

  • Promise<void>

Inherited from: BaseTask.cancel

Defined in: packages/task/index.ts:145

cancelTask

ts
cancelTask(): Promise<void>

Return Type

  • Promise<void>

Defined in: packages/task/index.ts:299

get

ts
get(): void | T

Return Type

  • void | T

Inherited from: BaseTask.get

Defined in: packages/task/index.ts:108

map

ts
map(transform: Transform<TaskGroup<T>, N>): Task<N extends Promise<R> ? R : N>

Parameters

  • transform: Transform<TaskGroup<T>, N>

Return Type

  • Task<N extends Promise<R> ? R : N>

Inherited from: BaseTask.map

Defined in: packages/task/index.ts:212

onChildUpdate

ts
onChildUpdate(chunkSize: number): void

Parameters

  • chunkSize: number

Return Type

  • void

Defined in: packages/task/index.ts:287

pause

ts
pause(): Promise<void>

Return Type

  • Promise<void>

Inherited from: BaseTask.pause

Defined in: packages/task/index.ts:129

pauseTask

ts
pauseTask(): Promise<void>

Return Type

  • Promise<void>

Defined in: packages/task/index.ts:303

resume

ts
resume(): Promise<void>

Return Type

  • Promise<void>

Inherited from: BaseTask.resume

Defined in: packages/task/index.ts:137

resumeTask

ts
resumeTask(): Promise<void>

Return Type

  • Promise<void>

Defined in: packages/task/index.ts:307

runTask

ts
runTask(): Promise<T>

Return Type

  • Promise<T>

Inherited from: BaseTask.runTask

Defined in: packages/task/index.ts:207

setName

ts
setName(name: string, param: object): TaskGroup<T>

Parameters

  • name: string
  • param: object

Return Type

  • TaskGroup<T>

Inherited from: BaseTask.setName

Defined in: packages/task/index.ts:102

start

ts
start(context: TaskContext, parent: Task<any>): void

Parameters

  • context: TaskContext
  • parent: Task<any>

Return Type

  • void

Inherited from: BaseTask.start

Defined in: packages/task/index.ts:164

startAndWait

ts
startAndWait(context: TaskContext, parent: Task<any>): Promise<T>

Parameters

  • context: TaskContext
  • parent: Task<any>

Return Type

  • Promise<T>

Inherited from: BaseTask.startAndWait

Defined in: packages/task/index.ts:195

update

ts
update(chunkSize: number): void

Parameters

  • chunkSize: number

Return Type

  • void

Inherited from: BaseTask.update

Defined in: packages/task/index.ts:200

wait

ts
wait(): Promise<T>

Return Type

  • Promise<T>

Inherited from: BaseTask.wait

Defined in: packages/task/index.ts:160

Released under the MIT License.