Interface SandboxedJob<T, R>

See

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

interface SandboxedJob<T, R> {
    attemptsMade: number;
    attemptsStarted: number;
    data: T;
    debounceId?: string;
    deduplicationId?: string;
    failedReason: string;
    finishedOn?: number;
    id: string;
    log: ((row) => void);
    moveToDelayed: ((timestamp, token?) => Promise<void>);
    name: string;
    opts: JobsOptions;
    parent?: ParentKeys;
    parentKey?: string;
    prefix: string;
    processedBy?: string;
    processedOn?: number;
    progress: number | object;
    queueName: string;
    repeatJobKey?: string;
    returnValue: R;
    returnvalue: string;
    stacktrace: string;
    timestamp: number;
    updateData: ((data) => Promise<void>);
    updateProgress: ((value) => Promise<void>);
}

Type Parameters

  • T = any
  • R = any

Hierarchy

Properties

attemptsMade attemptsStarted data debounceId? deduplicationId? failedReason finishedOn? id log moveToDelayed name opts parent? parentKey? prefix processedBy? processedOn? progress queueName repeatJobKey? returnValue returnvalue stacktrace timestamp updateData updateProgress

Properties

attemptsMade

attemptsMade: number

attemptsStarted

attemptsStarted: number

data

data: T

Optional debounceId

debounceId?: string

Optional deduplicationId

deduplicationId?: string

failedReason

failedReason: string

Optional finishedOn

finishedOn?: number

id

id: string

log

log: ((row) => void)

Type declaration

    • (row): void

    • Parameters

      • row: any

      Returns void

moveToDelayed

moveToDelayed: ((timestamp, token?) => Promise<void>)

Type declaration

    • (timestamp, token?): Promise<void>

    • Parameters

      • timestamp: number
      • Optional token: string

      Returns Promise<void>

name

name: string

opts

opts: JobsOptions

Optional parent

parent?: ParentKeys

Optional parentKey

parentKey?: string

prefix

prefix: string

Optional processedBy

processedBy?: string

Optional processedOn

processedOn?: number

progress

progress: number | object

queueName

queueName: string

Optional repeatJobKey

repeatJobKey?: string

returnValue

returnValue: R

returnvalue

returnvalue: string

stacktrace

stacktrace: string

timestamp

timestamp: number

updateData

updateData: ((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