bullmq - v5.73.5
    Preparing search index...

    Interface SandboxedJob<T, R>

    interface SandboxedJob<T = any, R = any> {
        attemptsMade: number;
        attemptsStarted: number;
        data: T;
        debounceId?: string;
        deduplicationId?: string;
        failedReason: string;
        finishedOn?: number;
        getChildrenValues: <CT = any>() => Promise<{ [jobKey: string]: CT }>;
        getDependenciesCount: (
            opts?: {
                failed?: boolean;
                ignored?: boolean;
                processed?: boolean;
                unprocessed?: boolean;
            },
        ) => Promise<
            {
                failed?: number;
                ignored?: number;
                processed?: number;
                unprocessed?: number;
            },
        >;
        getIgnoredChildrenFailures: () => Promise<{ [jobKey: string]: string }>;
        id: string;
        log: (row: string) => void;
        moveToDelayed: (timestamp: number, token?: string) => Promise<void>;
        moveToWait: (token?: string) => Promise<void>;
        moveToWaitingChildren: (
            token?: string,
            opts?: MoveToWaitingChildrenOpts,
        ) => Promise<boolean>;
        name: string;
        nextRepeatableJobKey?: string;
        opts: JobsOptions;
        parent?: ParentKeys;
        parentKey?: string;
        prefix: string;
        processedBy?: string;
        processedOn?: number;
        progress: JobProgress;
        queueName: string;
        queueQualifiedName: string;
        repeatJobKey?: string;
        returnvalue: string;
        returnValue: R;
        stacktrace: string;
        stalledCounter: number;
        timestamp: number;
        updateData: (data: T) => Promise<void>;
        updateProgress: (value: JobProgress) => Promise<void>;
    }

    Type Parameters

    • T = any
    • R = any

    Hierarchy

    Index

    Properties

    attemptsMade: number
    attemptsStarted: number
    data: T
    debounceId?: string
    deduplicationId?: string
    failedReason: string
    finishedOn?: number
    getChildrenValues: <CT = any>() => Promise<{ [jobKey: string]: CT }>
    getDependenciesCount: (
        opts?: {
            failed?: boolean;
            ignored?: boolean;
            processed?: boolean;
            unprocessed?: boolean;
        },
    ) => Promise<
        {
            failed?: number;
            ignored?: number;
            processed?: number;
            unprocessed?: number;
        },
    >
    getIgnoredChildrenFailures: () => Promise<{ [jobKey: string]: string }>
    id: string
    log: (row: string) => void
    moveToDelayed: (timestamp: number, token?: string) => Promise<void>
    moveToWait: (token?: string) => Promise<void>
    moveToWaitingChildren: (
        token?: string,
        opts?: MoveToWaitingChildrenOpts,
    ) => Promise<boolean>
    name: string
    nextRepeatableJobKey?: string
    parent?: ParentKeys
    parentKey?: string
    prefix: string
    processedBy?: string
    processedOn?: number
    progress: JobProgress
    queueName: string
    queueQualifiedName: string
    repeatJobKey?: string
    returnvalue: string
    returnValue: R
    stacktrace: string
    stalledCounter: number
    timestamp: number
    updateData: (data: T) => Promise<void>
    updateProgress: (value: JobProgress) => Promise<void>