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

    Interface SandboxedWorkerOptions

    Sandboxed worker configuration

    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

    Auto-restart crashed workers (default: true)

    autoStart?: boolean

    Auto-restart worker pool when new jobs arrive after idle shutdown (default: false)

    autoStartPollMs?: number

    Poll interval in ms for checking new jobs while in idle-shutdown state (default: 5000)

    concurrency?: number

    Number of worker processes (default: 1)

    connection?: ConnectionOptions

    TCP connection options (if provided, uses TCP mode instead of embedded)

    heartbeatInterval?: number

    Heartbeat interval in ms for TCP lock renewal (default: 10000 for TCP, 0 for embedded)

    idleRecycleMs?: number

    Recycle individual idle worker processes after this many ms (default: 30000, 0 = disabled)

    idleTimeout?: number

    Auto-stop after this many ms of inactivity (0 = disabled, default: 0)

    manager?: QueueManager

    Custom QueueManager (for testing, defaults to shared manager)

    maxMemory?: number

    Max memory per worker in MB - uses smol mode if <= 64 (default: 256)

    maxRestarts?: number

    Max restarts before giving up (default: 10)

    pollInterval?: number

    Poll interval when no workers are idle (default: 10ms)

    processor: string

    Path to processor file (must export default async function)

    timeout?: number

    Job timeout in ms (default: 30000)

    Settings
    Member Visibility

    On This Page
    Properties