Class Job<DataType, ReturnType, NameType>

attemptsMade

data

delay

failedReason

Optional finishedOn

Optional id

name

Optional parent

Optional parentKey

Optional processedOn

progress

Optional repeatJobKey

returnvalue

stacktrace

timestamp

Optional token

prefix

• get prefix(): string

• Returns string

  the prefix that is used.

queueName

• get queueName(): string

• Returns string

  the queue name this job belongs to.

queueQualifiedName

• get queueQualifiedName(): string

• Returns string

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

  See

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

addJob

• addJob(client, parentOpts?): Promise<string>

• Adds the job to Redis.

  Parameters

  • client: RedisClient

  • Optional parentOpts: ParentOpts

  Returns Promise<string>

asJSON

• asJSON(): JobJson

• Prepares a job to be serialized for storage in Redis.

  Returns JobJson

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

changePriority

• changePriority(opts): Promise<void>

• Change job priority.

  Parameters

  • opts: {
        lifo?: boolean;
        priority?: number;
    }

    • Optional lifo?: boolean

    • Optional priority?: number

  Returns Promise<void>

  void

clearLogs

• clearLogs(keepLogs?): Promise<void>

• Clears job's logs

  Parameters

  • Optional keepLogs: number

    the amount of log entries to preserve

  Returns Promise<void>

discard

• discard(): void

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

  Returns void

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.

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

  • Optional opts: DependenciesOpts

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

  dependencies separated by processed and unprocessed.

getDependenciesCount

• getDependenciesCount(opts?): Promise<{
      processed?: number;
      unprocessed?: number;
  }>

• Get children job counts if this job is a parent and has children.

  Parameters

  • Optional opts: {
        processed?: boolean;
        unprocessed?: boolean;
    }

    • Optional processed?: boolean

    • Optional unprocessed?: boolean

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

  dependencies count separated by processed and unprocessed.

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'.

isActive

• isActive(): Promise<boolean>

• Returns Promise<boolean>

  true of the job is active.

isCompleted

• isCompleted(): Promise<boolean>

• Returns Promise<boolean>

  true if the job has completed.

isDelayed

• isDelayed(): Promise<boolean>

• Returns Promise<boolean>

  true if the job is delayed.

isFailed

• isFailed(): Promise<boolean>

• Returns Promise<boolean>

  true if the job has failed.

isWaiting

• isWaiting(): Promise<boolean>

• Returns Promise<boolean>

  true if the job is waiting.

isWaitingChildren

• isWaitingChildren(): Promise<boolean>

• Returns Promise<boolean>

  true if the job is waiting for children.

log

• log(logRow): Promise<number>

• Logs one row of log data.

  Parameters

  • logRow: string

    string with log data to be logged.

  Returns Promise<number>

promote

• promote(): Promise<void>

• Promotes a delayed job so that it starts to be processed as soon as possible.

  Returns Promise<void>

remove

• remove(): 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.

  Returns Promise<void>

retry

• retry(state?): Promise<void>

• Attempts to retry the job. Only a job that has failed or completed can be retried.

  Parameters

  • Optional state: FinishedStatus

    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

toJSON

• toJSON(): Omit<Job<DataType, ReturnType, NameType>, "toJSON" | "scripts" | "prefix" | "discard" | "queue" | "asJSON" | "asJSONSandbox" | "update" | "updateProgress" | "log" | "clearLogs" | "remove" | "extendLock" | "moveToCompleted" | "moveToFailed" | "isCompleted" | "isFailed" | "isDelayed" | "isWaitingChildren" | "isActive" | "isWaiting" | "queueName" | "queueQualifiedName" | "getState" | "changeDelay" | "changePriority" | "getChildrenValues" | "getDependencies" | "getDependenciesCount" | "waitUntilFinished" | "moveToDelayed" | "moveToWaitingChildren" | "promote" | "retry" | "addJob">

• Returns Omit<Job<DataType, ReturnType, NameType>, "toJSON" | "scripts" | "prefix" | "discard" | "queue" | "asJSON" | "asJSONSandbox" | "update" | "updateProgress" | "log" | "clearLogs" | "remove" | "extendLock" | "moveToCompleted" | "moveToFailed" | "isCompleted" | "isFailed" | "isDelayed" | "isWaitingChildren" | "isActive" | "isWaiting" | "queueName" | "queueQualifiedName" | "getState" | "changeDelay" | "changePriority" | "getChildrenValues" | "getDependencies" | "getDependenciesCount" | "waitUntilFinished" | "moveToDelayed" | "moveToWaitingChildren" | "promote" | "retry" | "addJob">

update

• update(data): Promise<void>

• Updates a job's data

  Parameters

  • data: DataType

    the data that will replace the current jobs data.

  Returns Promise<void>

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>

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>

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>>

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>[]>

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>>