bullmq - v5.56.2
    Preparing search index...

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    not in use anymore.

    connection: ConnectionOptions

    Options for connecting to a Redis instance.

    defaultJobOptions?: DefaultJobOptions
    prefix?: string

    Prefix for all queue keys.

    settings?: AdvancedRepeatOptions

    Advanced options for the repeatable jobs.

    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.

    false
    skipVersionCheck?: boolean

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

    false
    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.

    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.

    telemetry?: Telemetry

    Telemetry client

    Settings

    Member Visibility

    On This Page

    Properties