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

    Interface QueueManagerConfig

    Queue Manager configuration.

    interface QueueManagerConfig {
        cleanupIntervalMs?: number;
        completedRetentionMs?: number | null;
        dataPath?: string;
        dependencyCheckMs?: number;
        dlqMaintenanceMs?: number;
        jobTimeoutCheckMs?: number;
        maxCompletedJobs?: number;
        maxCustomIds?: number;
        maxJobLogs?: number;
        maxJobResults?: number;
        maxMetricDataPoints?: number;
        maxPrometheusQueues?: number;
        maxQueueEvents?: number;
        maxRemovedResults?: number;
        maxWaitingDeps?: number;
        removedResultRetentionMs?: number;
        stallCheckMs?: number;
        validateWebhookUrls?: boolean;
    }
    Index
    cleanupIntervalMs? completedRetentionMs? dataPath? dependencyCheckMs? dlqMaintenanceMs? jobTimeoutCheckMs? maxCompletedJobs? maxCustomIds? maxJobLogs? maxJobResults? maxMetricDataPoints? maxPrometheusQueues? maxQueueEvents? maxRemovedResults? maxWaitingDeps? removedResultRetentionMs? stallCheckMs? validateWebhookUrls?
    cleanupIntervalMs?: number

    Memory-cleanup period (default 10000).

    completedRetentionMs?: number | null

    Delete retained completed jobs after this age; null/undefined disables automatic retention.

    dataPath?: string
    dependencyCheckMs?: number

    Dependency safety-net period (default 30000).

    dlqMaintenanceMs?: number

    DLQ maintenance period (default 60000).

    jobTimeoutCheckMs?: number

    Retry delay after a processing-timeout transition fails (default 5000).

    maxCompletedJobs?: number
    maxCustomIds?: number
    maxJobLogs?: number
    maxJobResults?: number
    maxMetricDataPoints?: number

    Maximum retained one-minute metric buckets per queue and terminal state.

    maxPrometheusQueues?: number

    Maximum queue label values emitted in one Prometheus scrape; zero disables them.

    maxQueueEvents?: number

    Maximum retained lifecycle events per queue.

    maxRemovedResults?: number

    Maximum retained removed-job results (default 1000); 0 disables the retention.

    maxWaitingDeps?: number
    removedResultRetentionMs?: number

    How long the result of a job removed on completion stays readable by the completion lookup (WaitJob, waitUntilFinished), in ms (default 60000). Memory only; 0 disables it. A value that is not a finite number >= 0 means the default.

    stallCheckMs?: number

    Stall-detection and lock-expiration period (default 5000).

    validateWebhookUrls?: boolean

    Settings
    Member Visibility

    On This Page
    Properties