Logos DX
    Preparing search index...

    The options for the queue

    interface QueueOpts {
        autoStart?: boolean;
        concurrency?: number;
        debug?: boolean | "info" | "verbose";
        jitterFactor?: number;
        maxQueueSize?: number;
        name: string;
        pollIntervalMs?: number;
        processIntervalMs?: number;
        rateLimitCapacity?: number;
        rateLimitIntervalMs?: number;
        taskTimeoutMs?: number;
        type?: "fifo" | "lifo";
    }
    Index

    Properties

    autoStart?: boolean

    Automatically start the queue

    true
    
    concurrency?: number

    The concurrency of the queue

    1
    
    debug?: boolean | "info" | "verbose"

    Whether to enable debug mode. Can be set to 'info' or 'verbose' to get more detailed output.

    false
    
    jitterFactor?: number

    The jitter percentage to displace the next process time. This stops all concurrent processes from happening at the same time.

    [0, 1]

    1
    
    maxQueueSize?: number

    The maximum size of the queue

    999_999_999
    
    name: string

    The name of the queue

    pollIntervalMs?: number

    The poll interval in milliseconds before the queue will check for new items after idle.

    100
    
    processIntervalMs?: number

    The interval in milliseconds before picking up the next item

    If the interval is 0, the queue will not wait between items

    0
    
    rateLimitCapacity?: number

    The rate limit of the queue in items per window

    999_999_999
    
    rateLimitIntervalMs?: number

    The rate limit window in milliseconds

    1000
    
    taskTimeoutMs?: number

    The timeout in milliseconds before the task is considered timed out

    If the timeout is 0, the task will not be considered timed out

    0
    
    type?: "fifo" | "lifo"

    The type of queue to use

    'fifo'