Class Job<DataType, ReturnType, NameType>

Job

This class represents a Job in the queue. Normally job are implicitly created when you add a job to the queue with methods such as Queue.addJob( ... )

A Job instance is also passed to the Worker's process function.

Job

Type Parameters

DataType = any
ReturnType = any
NameType extends string = string

Implements

MinimalJob<DataType, ReturnType, NameType>

Constructors

constructor

new Job<DataType, ReturnType, NameType>(queue, name, data, opts?, id?): Job<DataType, ReturnType, NameType>
Type Parameters
- DataType = any
- ReturnType = any
- NameType extends string = string
Parameters
- queue: MinimalQueue
- name: NameType
  The name of the Job
- data: DataType
  The payload for this job.
- opts: JobsOptions = {}
  The options object for this job.
- Optional id: string
Returns Job<DataType, ReturnType, NameType>
- Defined in classes/job.ts:160

Properties

attemptsMade

attemptsMade: number = 0

Number of attempts after the job has failed.

Default Value

attemptsStarted

attemptsStarted: number = 0

Number of attempts when job is moved to active.

Default Value

data

data: DataType

The payload for this job.

delay

delay: number

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

Default Value

failedReason

failedReason: string

Reason for failing.

`Optional` finishedOn

finishedOn?: number

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

`Optional` id

id?: string

name

name: NameType

The name of the Job

opts

opts: JobsOptions = {}

The options object for this job.

`Optional` parent

parent?: ParentKeys

Object that contains parentId (id) and parent queueKey.

`Optional` parentKey

parentKey?: string

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

`Optional` processedBy

processedBy?: string

The worker name that is processing or processed this job.

`Optional` processedOn

processedOn?: number

Timestamp for when the job was processed.

progress

progress: number | object = 0

The progress a job has performed so far.

Default Value

`Readonly` queueQualifiedName

queueQualifiedName: string

It includes the prefix, the namespace separator :, and queue name.

See

https://www.gnu.org/software/gawk/manual/html_node/Qualified-Names.html

`Optional` repeatJobKey

repeatJobKey?: string

Base repeat job key.

returnvalue

returnvalue: ReturnType = null

The value returned by the processor when processing this job.

Default Value

null

stacktrace

stacktrace: string[] = null

Stacktrace for the error (for failed jobs).

Default Value

null

timestamp

timestamp: number

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

`Optional` token

token?: string

The token used for locking this job.

Accessors

prefix

get prefix(): string
Returns string
the prefix that is used.
Implementation of MinimalJob.prefix
- Defined in classes/job.ts:801

queueName

get queueName(): string
Returns string
the queue name this job belongs to.
Implementation of MinimalJob.queueName
- Defined in classes/job.ts:794

Methods

addJob

addJob(client, parentOpts?): Promise<string>
Adds the job to Redis.
Parameters
- client: RedisClient
- Optional parentOpts: ParentOpts
Returns Promise<string>
- Defined in classes/job.ts:1178

asJSON

asJSON(): JobJson
Prepares a job to be serialized for storage in Redis.

Returns JobJson
Implementation of MinimalJob.asJSON
- Defined in classes/job.ts:446

asJSONSandbox

asJSONSandbox(): JobJsonSandbox
Prepares a job to be passed to Sandbox.

Returns JobJsonSandbox
Implementation of MinimalJob.asJSONSandbox
- Defined in classes/job.ts:489

changeDelay

changeDelay(delay): Promise<void>
Change delay of a delayed job.
Parameters
- delay: number
  milliseconds to be added to current time.
Returns Promise<void>
void
- Defined in classes/job.ts:821

changePriority

changePriority(opts): Promise<void>
Change job priority.
Parameters
- opts: {
  lifo?: boolean;
  priority?: number;
  }
  - Optional lifo?: boolean
  - Optional priority?: number
Returns Promise<void>
void
- Defined in classes/job.ts:831

clearLogs

clearLogs(keepLogs?): Promise<void>
Clears job's logs
Parameters
- Optional keepLogs: number
  the amount of log entries to preserve
Returns Promise<void>
- Defined in classes/job.ts:553

discard

discard(): void
Marks a job to not be retried if it fails (even if attempts has been configured)

Returns void
- Defined in classes/job.ts:1156

extendLock

extendLock(token, duration): Promise<number>
Extend the lock for this job.
Parameters
- token: string
  unique token for the lock
- duration: number
  lock duration in milliseconds
Returns Promise<number>
- Defined in classes/job.ts:593

getChildrenValues

getChildrenValues<CT>(): Promise<{
[jobKey: string]: CT;
}>
Get this jobs children result values if any.
Type Parameters
- CT = any
Returns Promise<{
[jobKey: string]: CT;
}>
Object mapping children job keys with their values.
- Defined in classes/job.ts:843

getDependencies

getDependencies(opts?): Promise<{
    nextProcessedCursor?: number;
    nextUnprocessedCursor?: number;
    processed?: Record<string, any>;
    unprocessed?: string[];
}>
Get children job keys if this job is a parent and has children.
Parameters
- opts: DependenciesOpts = {}
Returns Promise<{
    nextProcessedCursor?: number;
    nextUnprocessedCursor?: number;
    processed?: Record<string, any>;
    unprocessed?: string[];
}>
dependencies separated by processed and unprocessed.

Remarks
Count options before Redis v7.2 works as expected with any quantity of entries on processed/unprocessed dependencies, since v7.2 you must consider that count won't have any effect until processed/unprocessed dependencies have a length greater than 127

See
https://redis.io/docs/management/optimization/memory-optimization/#redis--72
- Defined in classes/job.ts:876

getDependenciesCount

getDependenciesCount(opts?): Promise<{
processed?: number;
unprocessed?: number;
}>
Get children job counts if this job is a parent and has children.
Parameters
- opts: {
  processed?: boolean;
  unprocessed?: boolean;
  } = {}
  - Optional processed?: boolean
  - Optional unprocessed?: boolean
Returns Promise<{
processed?: number;
unprocessed?: number;
}>
dependencies count separated by processed and unprocessed.
- Defined in classes/job.ts:968

getFailedChildrenValues

getFailedChildrenValues(): Promise<{
[jobKey: string]: string;
}>
Get this jobs children failure values if any.

Returns Promise<{
[jobKey: string]: string;
}>
Object mapping children job keys with their failure values.
- Defined in classes/job.ts:860

getState

getState(): Promise<"unknown" | JobState>
Get current state.

Returns Promise<"unknown" | JobState>
Returns one of these values: 'completed', 'failed', 'delayed', 'active', 'waiting', 'waiting-children', 'unknown'.
- Defined in classes/job.ts:811

isActive

isActive(): Promise<boolean>
Returns Promise<boolean>
true of the job is active.
- Defined in classes/job.ts:780

isCompleted

isCompleted(): Promise<boolean>
Returns Promise<boolean>
true if the job has completed.
- Defined in classes/job.ts:752

isDelayed

isDelayed(): Promise<boolean>
Returns Promise<boolean>
true if the job is delayed.
- Defined in classes/job.ts:766

isFailed

isFailed(): Promise<boolean>
Returns Promise<boolean>
true if the job has failed.
- Defined in classes/job.ts:759

isWaiting

isWaiting(): Promise<boolean>
Returns Promise<boolean>
true if the job is waiting.
- Defined in classes/job.ts:787

isWaitingChildren

isWaitingChildren(): Promise<boolean>
Returns Promise<boolean>
true if the job is waiting for children.
- Defined in classes/job.ts:773

log

log(logRow): Promise<number>
Logs one row of log data.
Parameters
- logRow: string
  string with log data to be logged.
Returns Promise<number>
The total number of log entries for this job so far.
Implementation of MinimalJob.log
- Defined in classes/job.ts:525

moveToCompleted

moveToCompleted(returnValue, token, fetchNext?): Promise<any[]>
Moves a job to the completed queue. Returned job to be used with Queue.prototype.nextJobFromJobData.
Parameters
- returnValue: ReturnType
  The jobs success message.
- token: string
  Worker token used to acquire completed job.
- fetchNext: boolean = true
  True when wanting to fetch the next job.
Returns Promise<any[]>
Returns the jobData of the next job in the waiting queue.
- Defined in classes/job.ts:606

moveToDelayed

moveToDelayed(timestamp, token?): Promise<void>
Moves the job to the delay set.
Parameters
- timestamp: number
  timestamp where the job should be moved back to "wait"
- Optional token: string
  token to check job is locked by current worker
Returns Promise<void>
- Defined in classes/job.ts:1092

moveToFailed

moveToFailed<E>(err, token, fetchNext?): Promise<void>
Moves a job to the failed queue.
Type Parameters
- E extends Error
Parameters
- err: E
  the jobs error message.
- token: string
  token to check job is locked by current worker
- fetchNext: boolean = false
  true when wanting to fetch the next job
Returns Promise<void>
void
- Defined in classes/job.ts:647

moveToWaitingChildren

moveToWaitingChildren(token, opts?): Promise<boolean>
Moves the job to the waiting-children set.
Parameters
- token: string
  Token to check job is locked by current worker
- opts: MoveToWaitingChildrenOpts = {}
  The options bag for moving a job to waiting-children.
Returns Promise<boolean>
true if the job was moved
- Defined in classes/job.ts:1112

promote

promote(): Promise<void>
Promotes a delayed job so that it starts to be processed as soon as possible.

Returns Promise<void>
- Defined in classes/job.ts:1128

remove

remove(opts?): Promise<void>
Completely remove the job from the queue. Note, this call will throw an exception if the job is being processed when the call is performed.
Parameters
- opts: {
  removeChildren: boolean;
  } = {}
  Options to remove a job
  - removeChildren: boolean
Returns Promise<void>
- Defined in classes/job.ts:571

removeChildDependency

removeChildDependency(): Promise<boolean>
Removes child dependency from parent when child is not yet finished

Returns Promise<boolean>
True if the relationship existed and if it was removed.
- Defined in classes/job.ts:534

retry

retry(state?): Promise<void>
Attempts to retry the job. Only a job that has failed or completed can be retried.
Parameters
- state: FinishedStatus = 'failed'
  completed / failed
Returns Promise<void>
If resolved and return code is 1, then the queue emits a waiting event otherwise the operation was not a success and throw the corresponding error. If the promise rejects, it indicates that the script failed to execute
- Defined in classes/job.ts:1144

toJSON

toJSON(): Omit<Job<DataType, ReturnType, NameType>, "remove" | "prefix" | "toJSON" | "scripts" | "changeDelay" | "changePriority" | "extendLock" | "getState" | "moveToDelayed" | "moveToWaitingChildren" | "promote" | "removeChildDependency" | "updateData" | "updateProgress" | "discard" | "addJob" | "queue" | "asJSON" | "asJSONSandbox" | "log" | "clearLogs" | "moveToCompleted" | "moveToFailed" | "isCompleted" | "isFailed" | "isDelayed" | "isWaitingChildren" | "isActive" | "isWaiting" | "queueName" | "getChildrenValues" | "getFailedChildrenValues" | "getDependencies" | "getDependenciesCount" | "waitUntilFinished" | "retry">
Returns Omit<Job<DataType, ReturnType, NameType>, "remove" | "prefix" | "toJSON" | "scripts" | "changeDelay" | "changePriority" | "extendLock" | "getState" | "moveToDelayed" | "moveToWaitingChildren" | "promote" | "removeChildDependency" | "updateData" | "updateProgress" | "discard" | "addJob" | "queue" | "asJSON" | "asJSONSandbox" | "log" | "clearLogs" | "moveToCompleted" | "moveToFailed" | "isCompleted" | "isFailed" | "isDelayed" | "isWaitingChildren" | "isActive" | "isWaiting" | "queueName" | "getChildrenValues" | "getFailedChildrenValues" | "getDependencies" | "getDependenciesCount" | "waitUntilFinished" | "retry">
- Defined in classes/job.ts:437

updateData

updateData(data): Promise<void>
Updates a job's data
Parameters
- data: DataType
  the data that will replace the current jobs data.
Returns Promise<void>
Implementation of MinimalJob.updateData
- Defined in classes/job.ts:502

updateProgress

updateProgress(progress): Promise<void>
Updates a job's progress
Parameters
- progress: number | object
  number or object to be saved as progress.
Returns Promise<void>
Implementation of MinimalJob.updateProgress
- Defined in classes/job.ts:513

waitUntilFinished

waitUntilFinished(queueEvents, ttl?): Promise<ReturnType>
Returns a promise the resolves when the job has completed (containing the return value of the job), or rejects when the job has failed (containing the failedReason).
Parameters
- queueEvents: QueueEvents
  Instance of QueueEvents.
- Optional ttl: number
  Time in milliseconds to wait for job to finish before timing out.
Returns Promise<ReturnType>
- Defined in classes/job.ts:1020

`Static` addJobLog

addJobLog(queue, jobId, logRow, keepLogs?): Promise<number>
addJobLog
Parameters
- queue: MinimalQueue
  Queue instance
- jobId: string
  Job id
- logRow: string
  Log row
- Optional keepLogs: number
  optional maximum number of logs to keep
Returns Promise<number>
The total number of log entries for this job so far.
- Defined in classes/job.ts:412

`Static` create

create<T, R, N>(queue, name, data, opts?): Promise<Job<T, R, N>>
Creates a new job and adds it to the queue.
Type Parameters
- T = any
- R = any
- N extends string = string
Parameters
- queue: MinimalQueue
  the queue where to add the job.
- name: N
  the name of the job.
- data: T
  the payload of the job.
- Optional opts: JobsOptions
  the options bag for this job.
Returns Promise<Job<T, R, N>>
- Defined in classes/job.ts:217

`Static` createBulk

createBulk<T, R, N>(queue, jobs): Promise<Job<T, R, N>[]>
Creates a bulk of jobs and adds them atomically to the given queue.
Type Parameters
- T = any
- R = any
- N extends string = string
Parameters
- queue: MinimalQueue
  the queue were to add the jobs.
- jobs: {
      data: T;
      name: N;
      opts?: BulkJobOptions;
  }[]
  an array of jobs to be added to the queue.
Returns Promise<Job<T, R, N>[]>
- Defined in classes/job.ts:244

`Static` fromId

fromId<T, R, N>(queue, jobId): Promise<Job<T, R, N>>
Fetches a Job from the queue given the passed job id.
Type Parameters
- T = any
- R = any
- N extends string = string
Parameters
- queue: MinimalQueue
  the queue where the job belongs to.
- jobId: string
  the job id.
Returns Promise<Job<T, R, N>>
- Defined in classes/job.ts:384

`Static` fromJSON

fromJSON<T, R, N>(queue, json, jobId?): Job<T, R, N>
Instantiates a Job from a JobJsonRaw object (coming from a deserialized JSON object)
Type Parameters
- T = any
- R = any
- N extends string = string
Parameters
- queue: MinimalQueue
  the queue where the job belongs to.
- json: JobJsonRaw
  the plain object containing the job.
- Optional jobId: string
  an optional job id (overrides the id coming from the JSON object)
Returns Job<T, R, N>
- Defined in classes/job.ts:291

Class Job<DataType, ReturnType, NameType>

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Job<DataType, ReturnType, NameType>

Properties

attemptsMade

Default Value

attemptsStarted

Default Value

data

delay

Default Value

failedReason

Optional finishedOn

Optional id

name

opts

Optional parent

Optional parentKey

Optional processedBy

Optional processedOn

progress

Default Value

Readonly queueQualifiedName

See

Optional repeatJobKey

returnvalue

Default Value

stacktrace

Default Value

timestamp

Optional token

Accessors

prefix

Returns string

queueName

Returns string

Methods

addJob

Parameters

Returns Promise<string>

asJSON

Returns JobJson

asJSONSandbox

Returns JobJsonSandbox

changeDelay

Parameters

Returns Promise<void>

changePriority

Parameters

Optional lifo?: boolean

Optional priority?: number

Returns Promise<void>

clearLogs

Parameters

Returns Promise<void>

discard

Returns void

extendLock

Parameters

Returns Promise<number>

getChildrenValues

Type Parameters

Returns Promise<{ [jobKey: string]: CT; }>

getDependencies

Parameters

Returns Promise<{ nextProcessedCursor?: number; nextUnprocessedCursor?: number; processed?: Record<string, any>; unprocessed?: string[]; }>

Remarks

See

getDependenciesCount

Parameters

`Optional` finishedOn

`Optional` id

`Optional` parent

`Optional` parentKey

`Optional` processedBy

`Optional` processedOn

`Readonly` queueQualifiedName

`Optional` repeatJobKey

`Optional` token

`Optional` lifo?: boolean

`Optional` priority?: number

Returns Promise<{
[jobKey: string]: CT;
}>

Returns Promise<{
nextProcessedCursor?: number;
nextUnprocessedCursor?: number;
processed?: Record<string, any>;
unprocessed?: string[];
}>

`Optional` processed?: boolean

`Optional` unprocessed?: boolean

Returns Promise<{
processed?: number;
unprocessed?: number;
}>

Returns Promise<{
[jobKey: string]: string;
}>

`Static` addJobLog

`Static` create

`Static` createBulk

`Static` fromId