bullmq - v5.76.5
    Preparing search index...

    Interface DefaultJobOptions

    interface DefaultJobOptions {
        attempts?: number;
        backoff?: number | BackoffOptions;
        delay?: number;
        keepLogs?: number;
        lifo?: boolean;
        priority?: number;
        removeOnComplete?: number | boolean | KeepJobs;
        removeOnFail?: number | boolean | KeepJobs;
        sizeLimit?: number;
        stackTraceLimit?: number;
        timestamp?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attempts?: number

    The total number of attempts to try the job until it completes.

    1
    
    backoff?: number | BackoffOptions

    Backoff setting for automatic retries if the job fails

    delay?: number

    An amount of milliseconds to wait until this job can be processed. Note that for accurate delays, worker and producers should have their clocks synchronized.

    0
    
    keepLogs?: number

    Maximum amount of log entries that will be preserved

    lifo?: boolean

    If true, adds the job to the right of the queue instead of the left (default false)

    priority?: number

    Ranges from 0 (highest priority) to 2 097 152 (lowest priority). Note that using priorities has a slight impact on performance, so do not use it if not required.

    0
    
    removeOnComplete?: number | boolean | KeepJobs

    If true, removes the job when it successfully completes When given a number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. It overrides whatever setting is used in the worker. Default behavior is to keep the job in the completed set.

    When using age or count, the eviction is evaluated on a best-effort basis every time a job finishes; BullMQ does not run a background timer, so aged jobs are only removed once another job completes after their expiration.

    removeOnFail?: number | boolean | KeepJobs

    If true, removes the job when it fails after all attempts. When given a number, it specifies the maximum amount of jobs to keep, or you can provide an object specifying max age and/or count to keep. It overrides whatever setting is used in the worker. Default behavior is to keep the job in the failed set.

    When using age or count, the eviction is evaluated on a best-effort basis every time a job fails; BullMQ does not run a background timer, so aged jobs are only removed once another job fails after their expiration.

    sizeLimit?: number

    Limits the size in bytes of the job's data payload (as a JSON serialized string).

    stackTraceLimit?: number

    Limits the amount of stack trace lines that will be recorded in the stacktrace.

    timestamp?: number

    Timestamp when the job was created.

    Date.now()