Interface QueueOptions

Options for the Queue class.

interface QueueOptions {
    blockingConnection?: boolean;
    connection: ConnectionOptions;
    defaultJobOptions?: DefaultJobOptions;
    prefix?: string;
    settings?: AdvancedRepeatOptions;
    skipMetasUpdate?: boolean;
    skipVersionCheck?: boolean;
    skipWaitingForReady?: boolean;
    streams?: {
        events: {
            maxLen: number;
        };
    };
    telemetry?: Telemetry<any>;
}

Hierarchy (view full)

Properties

blockingConnection? connection defaultJobOptions? prefix? settings? skipMetasUpdate? skipVersionCheck? skipWaitingForReady? streams? telemetry?

Properties

Optional blockingConnection

blockingConnection?: boolean

Denotes commands should retry indefinitely.

Deprecated

connection

connection: ConnectionOptions

Options for connecting to a Redis instance.

Optional defaultJobOptions

defaultJobOptions?: DefaultJobOptions

Optional prefix

prefix?: string

Prefix for all queue keys.

Optional settings

settings?: AdvancedRepeatOptions

Advanced options for the repeatable jobs.

Optional skipMetasUpdate

skipMetasUpdate?: boolean

Skip Meta update.

If true, the queue will not update the metadata of the queue. Useful for read-only systems that do should not update the metadata.

Default Value

false

Optional skipVersionCheck

skipVersionCheck?: boolean

Avoid version validation to be greater or equal than v5.0.0.

Default Value

false

Optional skipWaitingForReady

skipWaitingForReady?: boolean

Skip waiting for connection ready.

In some instances if you want the queue to fail fast if the connection is not ready you can set this to true. This could be useful for testing and when adding jobs via HTTP endpoints for example.

Optional streams

streams?: {
    events: {
        maxLen: number;
    };
}

Options for the streams used internally in BullMQ.

Type declaration

  • events: {
        maxLen: number;
    }

    Options for the events stream.

    • maxLen: number

      Max approximated length for streams. Default is 10 000 events.

Optional telemetry

telemetry?: Telemetry<any>

Telemetry client

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc