OptionalattemptsThe total number of attempts to try the job until it completes.
OptionalbackoffBackoff setting for automatic retries if the job fails
OptionalcontinueIf true, starts processing parent job as soon as any of its children fail.
OptionaldeduplicationDeduplication options.
OptionaldelayAn amount of milliseconds to wait until this job can be processed. Note that for accurate delays, worker and producers should have their clocks synchronized.
OptionalfailIf true, moves parent to failed if any of its children fail.
OptionalignoreIf true, moves the jobId from its parent dependencies to failed dependencies when it fails after all attempts.
OptionaljobOverride 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.
OptionalkeepMaximum amount of log entries that will be preserved
OptionallifoIf true, adds the job to the right of the queue instead of the left (default false)
OptionalparentParent options
OptionalprevInternal property used by repeatable jobs.
OptionalpriorityRanges from 0 to 2 097 151. 0 means no explicit priority, and jobs with
no explicit priority are processed before prioritized jobs. For prioritized
jobs, lower numbers are processed before higher numbers. Note that using
priorities has a slight impact on performance, so do not use it if not
required.
OptionalremoveIf true, removes the job from its parent dependencies when it fails after all attempts.
OptionalremoveIf 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.
When using age or count, the eviction is evaluated on a
best-effort basis every time a job finishes; BullMQ does not run a
background timer, so aged jobs are only removed once another job
completes after their expiration.
OptionalremoveIf 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.
When using age or count, the eviction is evaluated on a
best-effort basis every time a job fails; BullMQ does not run a
background timer, so aged jobs are only removed once another job
fails after their expiration.
OptionalrepeatOptionalrepeatInternal property used by repeatable jobs to save base repeat job key.
OptionalsizeLimits the size in bytes of the job's data payload (as a JSON serialized string).
OptionalstackLimits the amount of stack trace lines that will be recorded in the stacktrace.
OptionaltelemetryTelemetry options
OptionaltimestampTimestamp when the job was created.
Internal job options for jobs produced by a
JobScheduler. In addition to the public JobsOptions, scheduler-produced jobs carry the repeat settings the scheduler needs in order to schedule the next iteration. The legacy-onlykeyandjobIdrepeat fields are intentionally excluded.This type is internal:
repeatis no longer a valid option forQueue.add; useQueue.upsertJobSchedulerto schedule repeating jobs.