BullMQPluginOptions

BullMQPluginOptions

Package: @vendure/job-queue-plugin File: types.ts
v1.2.0

Configuration options for the BullMQJobQueuePlugin.

Signature

interface BullMQPluginOptions {
  connection?: ConnectionOptions;
  queueOptions?: Exclude<QueueOptions, 'connection'>;
  workerOptions?: Exclude<WorkerOptions, 'connection'>;
  schedulerOptions?: Exclude<QueueSchedulerOptions, 'connection'>;
}

Members

connection

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.

queueOptions

property
type:
Exclude<QueueOptions, 'connection'>
Additional options used when instantiating the BullMQ Queue instance. See the BullMQ QueueOptions docs

workerOptions

property
type:
Exclude<WorkerOptions, 'connection'>
Additional options used when instantiating the BullMQ Worker instance. See the BullMQ WorkerOptions docs

schedulerOptions

property
type:
Exclude<QueueSchedulerOptions, 'connection'>
Additional options used when instantiating the BullMQ QueueScheduler instance. See the BullMQ QueueSchedulerOptions docs