bullmq - v5.76.5
    Preparing search index...

    Interface QueueMeta

    Publicly relevant metadata fields for a Queue, read from the queue's Redis meta key.

    This interface documents the subset of meta-hash fields that BullMQ exposes to consumers (e.g. via Queue.getQueueOpts, Queue.getRateLimit, Queue.isPaused); the underlying hash also stores internal fields (e.g. metrics counters) that are not part of this type.

    interface QueueMeta {
        concurrency?: number;
        duration?: number;
        max?: number;
        maxLenEvents?: number;
        paused?: boolean;
        version?: string;
    }
    Index

    Properties

    concurrency?: number

    Maximum number of jobs that can be processed concurrently across all workers attached to this queue. Set via Queue.setGlobalConcurrency.

    duration?: number

    Length of the rate-limit window in milliseconds, paired with max. Set via Queue.setGlobalRateLimit.

    max?: number

    Maximum number of jobs allowed in the rate-limit window of duration milliseconds. Set via Queue.setGlobalRateLimit.

    maxLenEvents?: number

    Maximum length of the queue's events stream. Older events are evicted in FIFO order once the stream grows beyond this size.

    Note: maxLenEvents is not a guaranteed upper bound. BullMQ relies on Redis's XTRIM "fast trim" (MAXLEN ~ N), which is a best-effort cap — the stream may retain noticeably more events than this value at any given moment.

    paused?: boolean

    True when the queue has been paused. While paused, workers will not pick up new jobs.

    version?: string

    BullMQ version that produced this queue's data, used for compatibility checks across upgrades.