JS Task API Reference

Module: task

Table of contents

Enumerations

Classes

Interfaces

Type Aliases

Type Aliases

TaskFunction

Ƭ TaskFunction<OutputType>: (exe: ExeUnit) => Promise<OutputType>

Type parameters

Name
OutputType

Type declaration

▸ (exe): Promise<OutputType>

Parameters
NameType
exeExeUnit
Returns

Promise<OutputType>

Defined in

task.ts:10


TaskOptions

Ƭ TaskOptions: Object

Type declaration

NameTypeDescription
maxRetries?numbermaximum number of retries if task failed due to provider reason, default = 5
retryOnTimeout?booleanOpt-in for retries of the tasks when the timeout startupTimeout are reached Default ts false
timeout?numbertimeout in ms for task execution, measured for one attempt from start to stop, default = 300_000 (5min)
startupTimeout?numbertimeout in ms for task startup, measured from initialization to start, default = 120_000 (2min)

Defined in

task.ts:21


TaskDetails

Ƭ TaskDetails: Object

Type declaration

NameType
idstring
retriesCountnumber
agreementId?string
activityId?string
provider?ProviderInfo
error?Error

Defined in

task.ts:39

Was this helpful?