Interface WellIdentifiedTaskOptions<Binding>

Extends the task options with the task identifier, making it mandatory

interface WellIdentifiedTaskOptions<Binding = any> {
    bind?: Binding;
    id: string;
    priority?: number;
    retryOptions?: RetryOptions;
    retryStrategy?: RetryStrategy;
    weight?: number;
}

Type Parameters

  • Binding = any

Hierarchy (View Summary)

Properties

bind? id priority? retryOptions? retryStrategy? weight?

Properties

Optionalbind

bind?: Binding

Context to be bind to the task

id

id: string

Task identifier, it necessary to identify the task during all the process, for example, when the job is executed, the event with the task identifier will be emitted with the result of the task.

Optionalpriority

priority?: number

The priority of the task. A higher value means a higher priority. The default priority is 0.

Default Value

0

OptionalretryOptions

retryOptions?: RetryOptions

Set the options for the retry process of the task

Default Value

undefined

OptionalretryStrategy

retryStrategy?: RetryStrategy

Set the strategy to retry the task

Default Value

RETRY_STRATEGY.RETRY

Optionalweight

weight?: number

The weight of the task, this define the number of tokens that the task will consume from the bucket. The default weight is 1.

Default Value

1

Settings

Member Visibility

On This Page

Properties