DefaultJobQueuePlugin

export const config: VendureConfig = {  plugins: [    DefaultJobQueuePlugin.init({      pollInterval: queueName => {        if (queueName === 'cart-recovery-email') {          // This queue does not need to be polled so frequently,          // so we set a longer interval in order to reduce load          // on the database.          return 10000;        }        return 200;      },    }),  ],};

export const config: VendureConfig = {  plugins: [    DefaultJobQueuePlugin.init({      pollInterval: 5000,      concurrency: 2      backoffStrategy: (queueName, attemptsMade, job) => {        if (queueName === 'transcode-video') {          // exponential backoff example          return (attemptsMade ** 2) * 1000;        }        // A default delay for all other queues        return 1000;      },      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;      }    }),  ],};

export const config: VendureConfig = {  plugins: [    DefaultJobQueuePlugin.init({      // The number of completed/failed/cancelled      // jobs to keep in the database. The default is 1000.      keepJobsCount: 100,      // The interval at which to run the clean-up task.      // This can be a standard cron expression or a function      // that returns a cron expression. The default is every 2 hours.      cleanJobsSchedule: cron => cron.every(5).hours(),    }),  ],};

Signature

interface DefaultJobQueueOptions {    pollInterval?: number | ((queueName: string) => number);    concurrency?: number | ((queueName: string) => number);    backoffStrategy?: BackoffStrategy;    setRetries?: (queueName: string, job: Job) => number;    useDatabaseForBuffer?: boolean;    gracefulShutdownTimeout?: number;    keepJobsCount?: number;    cleanJobsSchedule?: ScheduledTaskConfig['schedule'];}

pollInterval

propertynumber | ((queueName: string) => number)

Default:200

The interval in ms between polling the database for new jobs. If many job queues are active, the polling may cause undue load on the database, in which case this value should be increased to e.g. 1000.

concurrency

propertynumber | ((queueName: string) => number)

Default:1

How many jobs from a given queue to process concurrently.

Can be set to a function which receives the queue name and returns the concurrency limit. This is useful for limiting concurrency on queues which have resource-intensive jobs.

Example

DefaultJobQueuePlugin.init({  concurrency: (queueName) => {    if (queueName === 'apply-collection-filters') {      return 1;    }    return 3;  }})

backoffStrategy

propertyBackoffStrategy

Default:() => 1000

The strategy used to decide how long to wait before retrying a failed job.

setRetries

property(queueName: string, job: Job) => number

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;}

useDatabaseForBuffer

propertybooleanv1.3.0

If set to true, the database will be used to store buffered jobs. This is recommended for production.

When enabled, a new JobRecordBuffer database entity will be defined which will require a migration when first enabling this option.

gracefulShutdownTimeout

propertynumberv2.2.0

Default:20_000

The timeout in ms which the queue will use when attempting a graceful shutdown. That means when the server is shut down but a job is running, the job queue will wait for the job to complete before allowing the server to shut down. If the job does not complete within this timeout window, the job will be forced to stop and the server will shut down anyway.

keepJobsCount

propertynumberv3.3.0

Default:1000

The number of completed/failed jobs to keep in the database. This is useful for debugging and auditing purposes, but if you have a lot of jobs, it may be desirable to limit the number of records in the database.

cleanJobsSchedule

propertyScheduledTaskConfig['schedule']v3.3.0

Default:cron => cron.every(2).hours()

The schedule for the "clean-jobs" task. This task will run periodically to clean up old jobs from the database. The schedule can be a cron expression or a function that returns a cron expression.