BullMQConfig

@tsed/bullmq

Usage

import { BullMQConfig } from "@tsed/third-parties/bullmq/src/types/config/config";

See /packages/third-parties/bullmq/src/types/config/config.ts.

Overview

type BullMQConfig = {
    queues?: string[];
    connection: ConnectionOptions;
    defaultQueueOptions?: Partial<QueueOptions>;
    queueOptions?: Record<string, Partial<QueueOptions>>;
    disableWorker?: boolean;
    workerQueues?: string[];
    defaultWorkerOptions?: Partial<WorkerOptions>;
    workerOptions?: Record<string, Partial<WorkerOptions>>;
};

queues

queues?: string[];

Specify queue name's to create

connection

connection: ConnectionOptions;

Default connection to use for queue's and worker's

defaultQueueOptions

defaultQueueOptions?: Partial<QueueOptions>;

Default queue options which are applied to every queue

Can be extended/overridden by queueOptions

queueOptions

queueOptions?: Record<string, Partial<QueueOptions>>;

Specify additional queue options by queue name

disableWorker

disableWorker?: boolean;

Disable the creation of any worker.

All other worker configuration will be ignored

workerQueues

workerQueues?: string[];

Specify for which queues to start a worker for.

Defaultly for every queue added in the queues parameter

defaultWorkerOptions

defaultWorkerOptions?: Partial<WorkerOptions>;

Default worker options which are applied to every worker

Can be extended/overridden by workerOptions

workerOptions

workerOptions?: Record<string, Partial<WorkerOptions>>;

Specify additional worker options by queue name