Overview
The ErrorCode enum contains error codes that can be returned by BullMQ’s Lua scripts when operations fail.
Enum
enum ErrorCode {
JobNotExist = -1,
JobLockNotExist = -2,
JobNotInState = -3,
JobPendingChildren = -4,
ParentJobNotExist = -5,
JobLockMismatch = -6,
ParentJobCannotBeReplaced = -7,
JobBelongsToJobScheduler = -8,
JobHasFailedChildren = -9,
SchedulerJobIdCollision = -10,
SchedulerJobSlotsBusy = -11,
}
Error Codes
JobNotExist
The specified job does not exist in Redis
// Example: Trying to get a non-existent job
const job = await queue.getJob('non-existent-id');
// job will be undefined
JobLockNotExist
The job’s lock does not exist
- The lock expired
- The job was never locked
- Another worker stole the lock
JobNotInState
The job is not in the expected state for the requested operation
// This will fail if job is not delayed
await job.promote();
JobPendingChildren
The job still has pending children and cannot be processed
ParentJobNotExist
The parent job specified does not exist
await queue.add('child', { data }, {
parent: {
id: 'non-existent-parent',
queue: 'bull:parentQueue',
},
});
JobLockMismatch
The provided lock token doesn’t match the job’s current lock
ParentJobCannotBeReplaced
ParentJobCannotBeReplaced
The parent job cannot be replaced while it has children
JobBelongsToJobScheduler
The job belongs to a job scheduler and cannot be modified directly
JobHasFailedChildren
The job cannot proceed because it has failed children
SchedulerJobIdCollision
A job scheduler with this ID already exists
SchedulerJobSlotsBusy
The job scheduler’s time slots are busy
Usage
These error codes are typically returned by internal Lua scripts and converted to JavaScript errors. You generally won’t use these directly, but they may appear in error messages:
import { Job } from 'bullmq';
try {
await job.promote();
} catch (error) {
console.error('Failed to promote job:', error.message);
// Error message may reference error codes
}
Handling Script Errors
When BullMQ operations fail, the errors usually include descriptive messages:
import { Queue } from 'bullmq';
const queue = new Queue('myQueue');
try {
await queue.remove('job-id');
} catch (error) {
if (error.message.includes('locked')) {
console.log('Job is locked by another worker');
} else if (error.message.includes('not exist')) {
console.log('Job does not exist');
}
}
