| title | isDefaultIndex | generated |
|---|---|---|
BullMQPluginOptions |
false |
true |
import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';
Configuration options for the BullMQJobQueuePlugin.
interface BullMQPluginOptions {
connection?: ConnectionOptions;
queueOptions?: Omit<QueueOptions, 'connection'>;
workerOptions?: Omit<WorkerOptions, 'connection'>;
setRetries?: (queueName: string, job: Job) => number;
setBackoff?: (queueName: string, job: Job) => BackoffOptions | undefined;
}<MemberInfo kind="property" type={ConnectionOptions} />
Connection options which will be passed directly to BullMQ when creating a new Queue, Worker and Scheduler instance.
If omitted, it will attempt to connect to Redis at 127.0.0.1:6379.
<MemberInfo kind="property" type={Omit<QueueOptions, 'connection'>} />
Additional options used when instantiating the BullMQ Queue instance. See the BullMQ QueueOptions docs
<MemberInfo kind="property" type={Omit<WorkerOptions, 'connection'>} />
Additional options used when instantiating the BullMQ Worker instance. See the BullMQ WorkerOptions docs
<MemberInfo kind="property" type={(queueName: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => number} since="1.3.0" />
When a job is added to the JobQueue using JobQueue.add(), the calling
code may specify the number of retries in case of failure. This option allows
you to override that number and specify your own number of retries based on
the job being added.
Example
setRetries: (queueName, job) => {
if (queueName === 'send-email') {
// Override the default number of retries
// for the 'send-email' job because we have
// a very unreliable email service.
return 10;
}
return job.retries;
}<MemberInfo kind="property" type={(queueName: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => <a href='/reference/core-plugins/job-queue-plugin/bull-mqplugin-options#backoffoptions'>BackoffOptions</a> | undefined} default="'exponential', 1000" since="1.3.0" />
This allows you to specify the backoff settings when a failed job gets retried.
In other words, this determines how much time should pass before attempting to
process the failed job again. If the function returns undefined, the default
value of exponential/1000ms will be used.
Example
setBackoff: (queueName, job) => {
return {
type: 'exponential', // or 'fixed'
delay: 10000 // first retry after 10s, second retry after 20s, 40s,...
};
}Configuration for the backoff function when retrying failed jobs.
interface BackoffOptions {
type: 'exponential' | 'fixed';
delay: number;
}