Interface SandboxedJob<T, R>

See

https://docs.bullmq.io/guide/workers/sandboxed-processors

interface SandboxedJob<T, R> {
    attemptsMade: number;
    data: T;
    failedReason: string;
    finishedOn?: number;
    id: string;
    log: ((row) => void);
    name: string;
    opts: JobsOptions;
    parent?: ParentKeys;
    parentKey?: string;
    processedOn?: number;
    repeatJobKey?: string;
    returnValue: R;
    returnvalue: string;
    stacktrace: string;
    timestamp: number;
    update: ((data) => Promise<void>);
    updateProgress: ((value) => Promise<void>);
}

Type Parameters

  • T = any
  • R = any

Hierarchy

  • Omit<JobJson, "data" | "opts" | "progress" | "returnValue">
    • SandboxedJob

Properties

attemptsMade data failedReason finishedOn? id log name opts parent? parentKey? processedOn? repeatJobKey? returnValue returnvalue stacktrace timestamp update updateProgress

Properties

attemptsMade

attemptsMade: number

data

data: T

failedReason

failedReason: string

Optional finishedOn

finishedOn?: number

id

id: string

log

log: ((row) => void)

Type declaration

    • (row): void

    • Parameters

      • row: any

      Returns void

name

name: string

opts

opts: JobsOptions

Optional parent

parent?: ParentKeys

Optional parentKey

parentKey?: string

Optional processedOn

processedOn?: number

Optional repeatJobKey

repeatJobKey?: string

returnValue

returnValue: R

returnvalue

returnvalue: string

stacktrace

stacktrace: string

timestamp

timestamp: number

update

update: ((data) => Promise<void>)

Type declaration

    • (data): Promise<void>

    • Parameters

      • data: any

      Returns Promise<void>

updateProgress

updateProgress: ((value) => Promise<void>)

Type declaration

    • (value): Promise<void>

    • Parameters

      • value: number | object

      Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc