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

    Interface Job

    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[];
        durable?: boolean;
        failParentOnFailure: boolean;
        groupId: string | null;
        id: JobId;
        ignoreDependencyOnFailure: boolean;
        keepLogs: number | null;
        lastHeartbeat: number;
        lifo: boolean;
        maxAttempts: number;
        name: string;
        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: 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[]
    durable?: boolean

    Whether SQLite admission bypasses its write buffer; PostgreSQL is always transactional.

    failParentOnFailure: boolean
    groupId: string | null
    id: JobId
    ignoreDependencyOnFailure: boolean
    keepLogs: number | null
    lastHeartbeat: number
    lifo: boolean
    maxAttempts: number
    name: string
    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