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

    Interface JobOptions

    Options accepted when adding a job.

    interface JobOptions {
        attempts?: number;
        backoff?: number | BackoffOptions;
        continueParentOnFailure?: boolean;
        debounce?: DebounceOptions;
        deduplication?: DeduplicationOptions;
        delay?: number;
        durable?: boolean;
        failParentOnFailure?: boolean;
        group?: GroupJobOptions;
        ignoreDependencyOnFailure?: boolean;
        jobId?: string;
        keepLogs?: number;
        lifo?: boolean;
        parent?: ParentOpts;
        priority?: number;
        removeDependencyOnFailure?: boolean;
        removeOnComplete?: boolean;
        removeOnFail?: boolean;
        repeat?: RepeatOptions;
        sizeLimit?: number;
        stackTraceLimit?: number;
        stallTimeout?: number;
        timeout?: number;
        timestamp?: number;
    }
    Index
    attempts? backoff? continueParentOnFailure? debounce? deduplication? delay? durable? failParentOnFailure? group? ignoreDependencyOnFailure? jobId? keepLogs? lifo? parent? priority? removeDependencyOnFailure? removeOnComplete? removeOnFail? repeat? sizeLimit? stackTraceLimit? stallTimeout? timeout? timestamp?
    attempts?: number
    backoff?: number | BackoffOptions
    continueParentOnFailure?: boolean
    debounce?: DebounceOptions
    deduplication?: DeduplicationOptions
    delay?: number

    Ms before the job is ready (at most 365 days); a negative delay is treated as 0.

    durable?: boolean
    failParentOnFailure?: boolean
    group?: GroupJobOptions
    ignoreDependencyOnFailure?: boolean
    jobId?: string
    keepLogs?: number
    lifo?: boolean
    parent?: ParentOpts
    priority?: number
    removeDependencyOnFailure?: boolean
    removeOnComplete?: boolean

    Age/count retention is intentionally unsupported.

    removeOnFail?: boolean
    repeat?: RepeatOptions
    sizeLimit?: number
    stackTraceLimit?: number
    stallTimeout?: number
    timeout?: number
    timestamp?: number

    Settings
    Member Visibility

    On This Page
    Properties