Interface DefaultJobOptions

Hierarchy

Properties

attempts?: number

The total number of attempts to try the job until it completes.

Default Value

0

backoff?: number | BackoffOptions

Backoff setting for automatic retries if the job fails

delay?: number

An amount of milliseconds to wait until this job can be processed. Note that for accurate delays, worker and producers should have their clocks synchronized.

Default Value

0

lifo?: boolean

If true, adds the job to the right of the queue instead of the left (default false)

See

https://docs.bullmq.io/guide/jobs/lifo

priority?: number

Ranges from 1 (highest priority) to MAX_INT (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required.

removeOnComplete?: number | boolean | KeepJobs

If true, removes the job when it successfully completes When given a number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. Default behavior is to keep the job in the completed set.

removeOnFail?: number | boolean | KeepJobs

If true, removes the job when it fails after all attempts. When given a number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep.

sizeLimit?: number

Limits the size in bytes of the job's data payload (as a JSON serialized string).

stackTraceLimit?: number

Limits the amount of stack trace lines that will be recorded in the stacktrace.

timestamp?: number

Timestamp when the job was created.

Default Value

Date.now()

Generated using TypeDoc