Class Task<T, I>

Type Parameters

T
I extends any[] = []

Hierarchy

Task

Index

Constructors

constructor

new Task<T, I>(callback: TaskCallback<T, I>, children?: Task<any, any[]>[], context?: object): Task<T, I>
Type Parameters
- T
- I extends any[] = []
Parameters
- callback: TaskCallback<T, I>
- children: Task<any, any[]>[] = []
- context: object = {}
Returns Task<T, I>
- Defined in packages/umi-tasks/src/Task.ts:38

Properties

`Protected` callback

callback: TaskCallback<T, I>

`Protected` children

children: Task<any, any[]>[]

`Protected` context

context: object

`Protected` error

error: unknown = undefined

`Protected` eventEmitter

eventEmitter: EventEmitter<string | symbol, any>

`Protected` result

result: undefined | T = undefined

`Protected` status

status: TaskStatus = 'pending'

Methods

`Protected` forceRun

forceRun(options?: TaskOptions, ...inputs: I): Promise<T>
Parameters
- options: TaskOptions = {}
- Rest ...inputs: I
Returns Promise<T>
- Defined in packages/umi-tasks/src/Task.ts:65

getChildren

getChildren(): Task<any, any[]>[]
Returns Task<any, any[]>[]
- Defined in packages/umi-tasks/src/Task.ts:126

getContext

getContext<C>(): C
Type Parameters
- C extends object = object
Returns C
- Defined in packages/umi-tasks/src/Task.ts:140

getDescendants

getDescendants(): Task<any, any[]>[]
Returns Task<any, any[]>[]
- Defined in packages/umi-tasks/src/Task.ts:130

getError

getError(): unknown
Returns unknown
- Defined in packages/umi-tasks/src/Task.ts:152

getResult

getResult(): undefined | T
Returns undefined | T
- Defined in packages/umi-tasks/src/Task.ts:148

getStatus

getStatus(): TaskStatus
Returns TaskStatus
- Defined in packages/umi-tasks/src/Task.ts:144

isCanceled

isCanceled(): boolean
Returns boolean
- Defined in packages/umi-tasks/src/Task.ts:176

isCompleted

isCompleted(): boolean
Returns boolean
- Defined in packages/umi-tasks/src/Task.ts:164

isFailed

isFailed(): boolean
Returns boolean
- Defined in packages/umi-tasks/src/Task.ts:172

isPending

isPending(): boolean
Returns boolean
- Defined in packages/umi-tasks/src/Task.ts:156

isRunning

isRunning(): boolean
Returns boolean
- Defined in packages/umi-tasks/src/Task.ts:160

isSuccessful

isSuccessful(): boolean
Returns boolean
- Defined in packages/umi-tasks/src/Task.ts:168

loadWith

loadWith(preloadedResult: T): Task<T, I>
Parameters
- preloadedResult: T
Returns Task<T, I>
- Defined in packages/umi-tasks/src/Task.ts:104

onCancel

onCancel(callback: (() => unknown)): Task<T, I>
Parameters
- callback: (() => unknown)
  - - (): unknown
    - Returns unknown
Returns Task<T, I>
- Defined in packages/umi-tasks/src/Task.ts:200

onFailure

onFailure(callback: (() => unknown)): Task<T, I>
Parameters
- callback: (() => unknown)
  - - (): unknown
    - Returns unknown
Returns Task<T, I>
- Defined in packages/umi-tasks/src/Task.ts:196

onStatusChange

onStatusChange(callback: ((status: TaskStatus) => unknown)): Task<T, I>
Parameters
- callback: ((status: TaskStatus) => unknown)
  - - (status: TaskStatus): unknown
    - Parameters
      
      status: TaskStatus
      
      Returns unknown
Returns Task<T, I>
- Defined in packages/umi-tasks/src/Task.ts:180

onStatusChangeTo

onStatusChangeTo(status: TaskStatus, callback: (() => unknown)): Task<T, I>
Parameters
- status: TaskStatus
- callback: (() => unknown)
  - - (): unknown
    - Returns unknown
Returns Task<T, I>
- Defined in packages/umi-tasks/src/Task.ts:186

onSuccess

onSuccess(callback: (() => unknown)): Task<T, I>
Parameters
- callback: (() => unknown)
  - - (): unknown
    - Returns unknown
Returns Task<T, I>
- Defined in packages/umi-tasks/src/Task.ts:192

reset

reset(): Task<T, I>
Returns Task<T, I>
- Defined in packages/umi-tasks/src/Task.ts:112

run

run(options?: TaskOptions, ...inputs: I): Promise<T>
Parameters
- options: TaskOptions = {}
- Rest ...inputs: I
Returns Promise<T>
- Defined in packages/umi-tasks/src/Task.ts:49

setChildren

setChildren(children: Task<any, any[]>[]): Task<T, I>
Parameters
- children: Task<any, any[]>[]
Returns Task<T, I>
- Defined in packages/umi-tasks/src/Task.ts:120

setContext

setContext(context: object): Task<T, I>
Parameters
- context: object
Returns Task<T, I>
- Defined in packages/umi-tasks/src/Task.ts:134

`Protected` setStatus

setStatus(newStatus: TaskStatus): void
Parameters
- newStatus: TaskStatus
Returns void
- Defined in packages/umi-tasks/src/Task.ts:204

Generated using TypeDoc