Optional attemptsThe total number of attempts to try the job until it completes.
0
Optional backoffBackoff setting for automatic retries if the job fails
Optional delayAn amount of milliseconds to wait until this job can be processed. Note that for accurate delays, worker and producers should have their clocks synchronized.
0
Optional failIf true, moves parent to failed.
Optional groupA queue can be divided into an unlimited amount of groups that can be defined dynamically as jobs are being added to a queue.
The group option allows you to specify the unique group Id where the given job will belong to, and processed according to group mechanics.
For more information about groups
The group id. If the group does not exist it will be created. (When the group becomes empty it will be deleted automatically)
Optional maxThe maximum number of jobs that can be added to a group.
If the limit has been reached an error with the type GroupMaxSizeExceededError will be thrown.
Optional priority?: numberRanges from 1 (highest priority) to 2 097 152 (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required.
Optional jobOverride the job ID - by default, the job ID is a unique integer, but you can use this setting to override it. If you use this option, it is up to you to ensure the jobId is unique. If you attempt to add a job with an id that already exists, it will not be added.
Optional keepMaximum amount of log entries that will be preserved
Optional lifoIf true, adds the job to the right of the queue instead of the left (default false)
Optional parentIt includes the prefix, the namespace separator :, and queue name.
Optional prevInternal property used by repeatable jobs.
Optional priorityRanges from 1 (highest priority) to 2 097 152 (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required.
Optional removeIf true, removes the job from its parent dependencies when it fails after all attempts.
Optional removeIf 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. It overrides whatever setting is used in the worker. Default behavior is to keep the job in the completed set.
Optional removeIf 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. It overrides whatever setting is used in the worker. Default behavior is to keep the job in the failed set.
Optional repeatRepeat this job, for example based on a cron schedule.
Optional repeatInternal property used by repeatable jobs to save base repeat job key.
Optional sizeLimits the size in bytes of the job's data payload (as a JSON serialized string).
Optional stackLimits the amount of stack trace lines that will be recorded in the stacktrace.
Optional timestampTimestamp when the job was created.
Date.now()
Generated using TypeDoc
See
JobsOptions