The name of the Job
The payload for this job.
The options object for this job.
Optionalid: stringNumber of attempts after the job has failed.
The payload for this job.
An amount of milliseconds to wait until this job can be processed.
Reason for failing.
OptionalfinishedTimestamp for when the job finished (completed or failed).
OptionalidThe name of the Job
The options object for this job.
OptionalparentObject that contains parentId (id) and parent queueKey.
OptionalparentFully qualified key (including the queue prefix) pointing to the parent of this job.
OptionalprocessedTimestamp for when the job was processed.
The progress a job has performed so far.
OptionalrepeatBase repeat job key.
The value returned by the processor when processing this job.
Stacktrace for the error (for failed jobs).
Timestamp when the job was created (unless overridden with job options).
the prefix that is used.
the queue name this job belongs to.
it includes the prefix, the namespace separator :, and queue name.
Adds the job to Redis.
OptionalparentOpts: ParentOptsPrepares a job to be serialized for storage in Redis.
Prepares a job to be passed to Sandbox.
Change delay of a delayed job.
milliseconds to be added to current time.
void
Marks a job to not be retried if it fails (even if attempts has been configured)
Extend the lock for this job.
unique token for the lock
lock duration in milliseconds
Get this jobs children result values if any.
Object mapping children job keys with their values.
Get children job keys if this job is a parent and has children.
dependencies separated by processed and unprocessed.
Get children job counts if this job is a parent and has children.
dependencies count separated by processed and unprocessed.
Get current state.
Returns one of these values: 'completed', 'failed', 'delayed', 'active', 'waiting', 'waiting-children', 'unknown'.
true of the job is active.
true if the job has completed.
true if the job is delayed.
true if the job has failed.
true if the job is waiting.
true if the job is waiting for children.
Logs one row of log data.
string with log data to be logged.
Moves a job to the completed queue. Returned job to be used with Queue.prototype.nextJobFromJobData.
The jobs success message.
Worker token used to acquire completed job.
True when wanting to fetch the next job.
Returns the jobData of the next job in the waiting queue.
Moves the job to the delay set.
timestamp where the job should be moved back to "wait"
Optionaltoken: stringtoken to check job is locked by current worker
Moves a job to the failed queue.
the jobs error message.
token to check job is locked by current worker
true when wanting to fetch the next job
void
Moves the job to the waiting-children set.
Token to check job is locked by current worker
The options bag for moving a job to waiting-children.
true if the job was moved
Promotes a delayed job so that it starts to be processed as soon as possible.
Completely remove the job from the queue. Note, this call will throw an exception if the job is being processed when the call is performed.
Attempts to retry the job. Only a job that has failed or completed can be retried.
completed / failed
If resolved and return code is 1, then the queue emits a waiting event otherwise the operation was not a success and throw the corresponding error. If the promise rejects, it indicates that the script failed to execute
Updates a job's data
the data that will replace the current jobs data.
Updates a job's progress
number or object to be saved as progress.
Returns a promise the resolves when the job has completed (containing the return value of the job), or rejects when the job has failed (containing the failedReason).
Instance of QueueEvents.
Optionalttl: numberTime in milliseconds to wait for job to finish before timing out.
StaticcreateCreates a new job and adds it to the queue.
the queue where to add the job.
the name of the job.
the payload of the job.
Optionalopts: JobsOptionsthe options bag for this job.
StaticcreateCreates a bulk of jobs and adds them atomically to the given queue.
the queue were to add the jobs.
an array of jobs to be added to the queue.
StaticfromFetches a Job from the queue given the passed job id.
the queue where the job belongs to.
the job id.
StaticfromInstantiates a Job from a JobJsonRaw object (coming from a deserialized JSON object)
the queue where the job belongs to.
the plain object containing the job.
OptionaljobId: stringan optional job id (overrides the id coming from the JSON object)
Job
This class represents a Job in the queue. Normally job are implicitly created when you add a job to the queue with methods such as Queue.addJob( ... )
A Job instance is also passed to the Worker's process function.
Job