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

    Interface SandboxedWorkerOptions

    Duration options are milliseconds, validated by the constructor: an invalid one throws a TypeError or RangeError naming it. Long values, above 2^31 - 1 ms too, are honoured exactly.

    interface SandboxedWorkerOptions {
        autoRestart?: boolean;
        autoStart?: boolean;
        autoStartPollMs?: number;
        concurrency?: number;
        connection?: ConnectionOptions;
        heartbeatInterval?: number;
        idleRecycleMs?: number;
        idleTimeout?: number;
        manager?: QueueManager;
        maxMemory?: number;
        maxRestarts?: number;
        pollInterval?: number;
        processor: string;
        timeout?: number;
    }
    Index
    autoRestart? autoStart? autoStartPollMs? concurrency? connection? heartbeatInterval? idleRecycleMs? idleTimeout? manager? maxMemory? maxRestarts? pollInterval? processor timeout?
    autoRestart?: boolean
    autoStart?: boolean
    autoStartPollMs?: number

    Wait between queue checks while idle-stopped. Default 5000; a finite number >= 1.

    concurrency?: number
    connection?: ConnectionOptions
    heartbeatInterval?: number

    Lease renewal period. Default 5000 embedded, 10000 TCP; <= 0 disables, else >= 1.

    idleRecycleMs?: number

    Recycle a spare idle thread after this long. Default 30000; 0 or Infinity disables it.

    idleTimeout?: number

    Stop the pool after this long idle. Default 0; 0 or Infinity disables it.

    manager?: QueueManager
    maxMemory?: number
    maxRestarts?: number
    pollInterval?: number

    Wait while every thread is busy. Default 10; a finite number >= 1.

    processor: string
    timeout?: number

    Per-job timeout. Default 30000; 0 or Infinity disables it.

    Settings
    Member Visibility

    On This Page
    Properties