Type Definitions

TaskExec() → {Promise.<any>}

Exec function. Background tasks must return Task.detach() and manage the task result with the Task.backgroundResolve() and Task.backgroundReject() functions.

Parameters:
NameTypeDescription
options.taskTask

The currently running Task.

options.dependsCollection.<string, Task>

Collection of tasks that this task depends upon.

Returns:
Type: 
Promise.<any>

TaskState

Type:
  • 'holding' | 'pending' | 'running' | 'background' | 'success' | 'failure'

TaskStop() → {Promise.<any>}

Stop function. Background tasks must manage the task result with the Task.backgroundResolve() and Task.backgroundReject() functions.

Returns:
Type: 
Promise.<any>