workloads / main / Task

Class: Task<P>

Extends

• Workload

Type Parameters

Type Parameter
P

Constructors

new Task()

new Task<P>(
   name, 
   work, 
options?): Task<P>

Parameters

Parameter	Type	Description
name	string	Name of the task.
work	(task) => Promise<void>	Function that processes a task.
options?	TaskOptions<P>	‐

Returns

Task<P>

Overrides

Workload.constructor

Methods

handleError()

handleError(
   error?, 
   data?, 
   executionId?): void

Parameters

Parameter	Type
error?	unknown
data?	P
executionId?	string

Returns

void

---

performLater()

performLater(data, options?): Promise<ExecutionId | ExecutionId[]>

Performs the task later, dispatching the task to a queue.

NOTES

In development, the task will be performed immediately.

In test, the task will collected ans can be retrieved with the performedTasks test helper.

Parameters

Parameter	Type
data	P | P[]
options?	PerformOptions

Returns

Promise<ExecutionId | ExecutionId[]>

---

performNow()

performNow(data): Promise<void>

Performs the task immediately in the current processs.

Parameters

Parameter	Type
data	P | P[]

Returns

Promise<void>

Properties

Property	Modifier	Type	Description
id	readonly	string	Unique ID
name	public	string	Name of the task.
options?	public	TaskOptions<P>	-
work	public	(task: object) => Promise<void>	Function that processes a task.