Class Task<T, I>

Type Parameters

T
I extends any[] = []

Hierarchy

Task

Index

Properties

`Protected` callback

callback: TaskCallback<T, I>

`Protected` children

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

`Protected` context

context: object

`Protected` status

status: TaskStatus = 'pending'

`Protected` result

result: undefined | T = undefined

`Protected` error

error: unknown = undefined

`Protected` eventEmitter

eventEmitter: EventEmitter<string | symbol, any>

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/js/src/utils/Task.ts:32

Methods

run

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

`Protected` forceRun

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

loadWith

loadWith(preloadedResult: T): Task<T, I>
Parameters
- preloadedResult: T
Returns Task<T, I>
- Defined in packages/js/src/utils/Task.ts:98

reset

reset(): Task<T, I>
Returns Task<T, I>
- Defined in packages/js/src/utils/Task.ts:106

setChildren

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

getChildren

getChildren(): Task<any, any[]>[]
Returns Task<any, any[]>[]
- Defined in packages/js/src/utils/Task.ts:120

getDescendants

getDescendants(): Task<any, any[]>[]
Returns Task<any, any[]>[]
- Defined in packages/js/src/utils/Task.ts:124

setContext

setContext(context: object): Task<T, I>
Parameters
- context: object
Returns Task<T, I>
- Defined in packages/js/src/utils/Task.ts:128

getContext

getContext<C>(): C
Type Parameters
- C extends object = object
Returns C
- Defined in packages/js/src/utils/Task.ts:134

getStatus

getStatus(): TaskStatus
Returns TaskStatus
- Defined in packages/js/src/utils/Task.ts:138

getResult

getResult(): undefined | T
Returns undefined | T
- Defined in packages/js/src/utils/Task.ts:142

getError

getError(): unknown
Returns unknown
- Defined in packages/js/src/utils/Task.ts:146

isPending

isPending(): boolean
Returns boolean
- Defined in packages/js/src/utils/Task.ts:150

isRunning

isRunning(): boolean
Returns boolean
- Defined in packages/js/src/utils/Task.ts:154

isCompleted

isCompleted(): boolean
Returns boolean
- Defined in packages/js/src/utils/Task.ts:158

isSuccessful

isSuccessful(): boolean
Returns boolean
- Defined in packages/js/src/utils/Task.ts:162

isFailed

isFailed(): boolean
Returns boolean
- Defined in packages/js/src/utils/Task.ts:166

isCanceled

isCanceled(): boolean
Returns boolean
- Defined in packages/js/src/utils/Task.ts:170

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/js/src/utils/Task.ts:174

onStatusChangeTo

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

onSuccess

onSuccess(callback: (() => unknown)): Task<T, I>
Parameters
- callback: (() => unknown)
  - - (): unknown
    - Returns unknown
Returns Task<T, I>
- Defined in packages/js/src/utils/Task.ts:186

onFailure

onFailure(callback: (() => unknown)): Task<T, I>
Parameters
- callback: (() => unknown)
  - - (): unknown
    - Returns unknown
Returns Task<T, I>
- Defined in packages/js/src/utils/Task.ts:190

onCancel

onCancel(callback: (() => unknown)): Task<T, I>
Parameters
- callback: (() => unknown)
  - - (): unknown
    - Returns unknown
Returns Task<T, I>
- Defined in packages/js/src/utils/Task.ts:194

`Protected` setStatus

setStatus(newStatus: TaskStatus): void
Parameters
- newStatus: TaskStatus
Returns void
- Defined in packages/js/src/utils/Task.ts:198

Generated using TypeDoc