bullmq - v5.64.0
    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;
        streams?: { events: { maxLen: number } };
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

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

    Settings

    Member Visibility

    On This Page

    Properties