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

    Interface Job

    Core job structure

    interface Job {
        attempts: number;
        backoff: number;
        backoffConfig: BackoffConfig | null;
        childrenCompleted: number;
        childrenIds: JobId[];
        completedAt: number | null;
        continueParentOnFailure: boolean;
        createdAt: number;
        customId: string | null;
        data: unknown;
        debounceId: string | null;
        debounceTtl: number | null;
        deduplicationExtend: boolean;
        deduplicationReplace: boolean;
        deduplicationTtl: number | null;
        dependsOn: JobId[];
        failParentOnFailure: boolean;
        groupId: string | null;
        id: JobId;
        ignoreDependencyOnFailure: boolean;
        keepLogs: number | null;
        lastHeartbeat: number;
        lifo: boolean;
        maxAttempts: number;
        parentId: JobId | null;
        priority: number;
        progress: number;
        progressMessage: string | null;
        queue: string;
        removeDependencyOnFailure: boolean;
        removeOnComplete: boolean;
        removeOnFail: boolean;
        repeat: RepeatConfig | null;
        runAt: number;
        sizeLimit: number | null;
        stacktrace: string[] | null;
        stackTraceLimit: number;
        stallCount: number;
        stallTimeout: number | null;
        startedAt: number | null;
        tags: string[];
        timeline: JobTimelineEntry[];
        timeout: number | null;
        ttl: number | null;
        uniqueKey: string | null;
    }
    Index
    attempts backoff backoffConfig childrenCompleted childrenIds completedAt continueParentOnFailure createdAt customId data debounceId debounceTtl deduplicationExtend deduplicationReplace deduplicationTtl dependsOn failParentOnFailure groupId id ignoreDependencyOnFailure keepLogs lastHeartbeat lifo maxAttempts parentId priority progress progressMessage queue removeDependencyOnFailure removeOnComplete removeOnFail repeat runAt sizeLimit stacktrace stackTraceLimit stallCount stallTimeout startedAt tags timeline timeout ttl uniqueKey
    attempts: number
    backoff: number

    Backoff delay in ms or backoff configuration

    backoffConfig: BackoffConfig | null

    Backoff configuration (if using object-based backoff)

    childrenCompleted: number
    childrenIds: JobId[]
    completedAt: number | null
    continueParentOnFailure: boolean

    Continue parent processing even if this child fails

    createdAt: number
    customId: string | null
    data: unknown
    debounceId: string | null

    Debounce ID

    debounceTtl: number | null

    Debounce TTL in milliseconds

    deduplicationExtend: boolean

    Extend deduplication TTL on duplicate

    deduplicationReplace: boolean

    Replace job data on duplicate while in delayed state

    deduplicationTtl: number | null

    Deduplication TTL in milliseconds

    dependsOn: JobId[]
    failParentOnFailure: boolean

    Fail parent job if this child job fails

    groupId: string | null
    id: JobId
    ignoreDependencyOnFailure: boolean

    Move job to parent's failed dependencies instead of blocking parent

    keepLogs: number | null

    Maximum number of log entries to keep

    lastHeartbeat: number
    lifo: boolean
    maxAttempts: number
    parentId: JobId | null
    priority: number
    progress: number
    progressMessage: string | null
    queue: string
    removeDependencyOnFailure: boolean

    Remove dependency relationship if this job fails

    removeOnComplete: boolean
    removeOnFail: boolean
    repeat: RepeatConfig | null
    runAt: number
    sizeLimit: number | null

    Maximum job data size in bytes

    stacktrace: string[] | null

    Last failure's stack trace lines (trimmed, capped at stackTraceLimit). Null until a FAIL carries a stack. (#74)

    stackTraceLimit: number

    Maximum stack trace lines to store

    stallCount: number
    stallTimeout: number | null
    startedAt: number | null
    tags: string[]
    timeline: JobTimelineEntry[]

    State transition timeline (in-memory only, not persisted to SQLite)

    timeout: number | null
    ttl: number | null
    uniqueKey: string | null

    Settings
    Member Visibility

    On This Page
    Properties