bunqueue v2.8 API referenceall versions · guide
bunqueue
    Preparing search index...

    Interface BunqueueOptions<T, R>

    Bunqueue options

    interface BunqueueOptions<T = unknown, R = unknown> {
        autoBatch?: AutoBatchOptions;
        autorun?: boolean;
        batch?: BatchConfig<T, R>;
        batchSize?: number;
        circuitBreaker?: CircuitBreakerConfig;
        concurrency?: number;
        connection?: ConnectionOptions;
        dataPath?: string;
        debounce?: BunqueueDebounceConfig;
        deduplication?: BunqueueDeduplicationConfig;
        defaultJobOptions?: JobOptions;
        dlq?: BunqueueDlqConfig;
        embedded?: boolean;
        heartbeatInterval?: number;
        limiter?: RateLimiterOptions;
        pollTimeout?: number;
        prefixKey?: string;
        priorityAging?: PriorityAgingConfig;
        processor?: Processor<T, R>;
        rateLimit?: RateLimiterOptions;
        removeOnComplete?: number | boolean | { age?: number; count?: number };
        removeOnFail?: number | boolean | { age?: number; count?: number };
        retry?: RetryConfig;
        routes?: Record<string, Processor<T, R>>;
        ttl?: JobTtlConfig;
    }

    Type Parameters

    • T = unknown
    • R = unknown
    Index
    autoBatch? autorun? batch? batchSize? circuitBreaker? concurrency? connection? dataPath? debounce? deduplication? defaultJobOptions? dlq? embedded? heartbeatInterval? limiter? pollTimeout? prefixKey? priorityAging? processor? rateLimit? removeOnComplete? removeOnFail? retry? routes? ttl?
    autoBatch?: AutoBatchOptions
    autorun?: boolean
    batch?: BatchConfig<T, R>
    batchSize?: number
    circuitBreaker?: CircuitBreakerConfig
    concurrency?: number
    connection?: ConnectionOptions
    dataPath?: string
    debounce?: BunqueueDebounceConfig

    Job debouncing defaults — applied via defaultJobOptions

    deduplication?: BunqueueDeduplicationConfig

    Job deduplication defaults — applied via defaultJobOptions

    defaultJobOptions?: JobOptions
    dlq?: BunqueueDlqConfig

    Dead letter queue auto-management

    embedded?: boolean
    heartbeatInterval?: number
    limiter?: RateLimiterOptions
    pollTimeout?: number
    prefixKey?: string

    Namespace prefix prepended to the queue name on the server. Lets multiple environments (e.g. dev:, prod:) share the same broker without their jobs, workers, cron schedulers, stats, or DLQ overlapping. Forwarded to both the internal Queue and Worker. See QueueOptions.prefixKey.

    priorityAging?: PriorityAgingConfig
    processor?: Processor<T, R>
    rateLimit?: RateLimiterOptions

    Rate limiting for the worker

    removeOnComplete?: number | boolean | { age?: number; count?: number }
    removeOnFail?: number | boolean | { age?: number; count?: number }
    retry?: RetryConfig
    routes?: Record<string, Processor<T, R>>
    ttl?: JobTtlConfig

    Settings
    Member Visibility

    On This Page
    Properties