bullmq - v5.55.0
    Preparing search index...

    Interface MinimalJob<DataType, ReturnType, NameType>

    MinimalJob

    interface MinimalJob<
        DataType = any,
        ReturnType = any,
        NameType extends string = string,
    > {
        attemptsMade: number;
        data: DataType;
        delay: number;
        failedReason: string;
        finishedOn?: number;
        id?: string;
        name: NameType;
        opts: JobsOptions;
        parent?: ParentKeys;
        parentKey?: string;
        processedOn?: number;
        progress: number | object;
        repeatJobKey?: string;
        returnvalue: ReturnType;
        stacktrace: string[];
        timestamp: number;
        get prefix(): string;
        get queueName(): string;
        get queueQualifiedName(): string;
        asJSON(): JobJson;
        asJSONSandbox(): JobJsonSandbox;
        log(logRow: string): Promise<number>;
        updateData(data: DataType): Promise<void>;
        updateProgress(progress: number | object): Promise<void>;
    }

    Type Parameters

    • DataType = any
    • ReturnType = any
    • NameType extends string = string

    Implemented by

    Index

    Properties

    attemptsMade data delay failedReason finishedOn? id? name opts parent? parentKey? processedOn? progress repeatJobKey? returnvalue stacktrace timestamp

    Accessors

    prefix queueName queueQualifiedName

    Methods

    asJSON asJSONSandbox log updateData updateProgress

    Properties

    attemptsMade: number

    Number of attempts after the job has failed.

    0
    data: DataType

    The payload for this job.

    delay: number

    An amount of milliseconds to wait until this job can be processed.

    0
    failedReason: string

    Reason for failing.

    finishedOn?: number

    Timestamp for when the job finished (completed or failed).

    id?: string
    name: NameType

    The name of the Job

    opts: JobsOptions

    The options object for this job.

    parent?: ParentKeys

    Object that contains parentId (id) and parent queueKey.

    parentKey?: string

    Fully qualified key (including the queue prefix) pointing to the parent of this job.

    processedOn?: number

    Timestamp for when the job was processed.

    progress: number | object

    The progress a job has performed so far.

    0
    repeatJobKey?: string

    Base repeat job key.

    returnvalue: ReturnType

    The value returned by the processor when processing this job.

    null
    stacktrace: string[]

    Stacktrace for the error (for failed jobs).

    null
    timestamp: number

    Timestamp when the job was created (unless overridden with job options).

    Accessors

    Methods

    • Logs one row of log data.

      Parameters

      • logRow: string

        string with log data to be logged.

      Returns Promise<number>

    • Updates a job's progress

      Parameters

      • progress: number | object

        number or object to be saved as progress.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods