Class JobPro<DataType, ReturnType, NameType>

constructor

• new JobPro<DataType = any, ReturnType = any, NameType extends string = string>(
      queue: MinimalQueuePro,
      name: NameType,
      data: DataType,
      opts?: JobsProOptions,
      id?: string,
  ): JobPro<DataType, ReturnType, NameType>

  Type Parameters

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

  Parameters

  • queue: MinimalQueuePro
  • name: NameType

    The name of the Job

  • data: DataType

    The payload for this job.

  • opts: JobsProOptions = {}

    The options object for this job.

  • Optionalid: string

  Returns JobPro<DataType, ReturnType, NameType>

gid

opts

asJSONSandbox

• asJSONSandbox(): JobProJsonSandbox

  Prepares a job to be passed to Sandbox.

  Returns JobProJsonSandbox

extendLock

• extendLock(token: string, duration: number): 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>

getBatch

• getBatch(): JobPro<DataType, ReturnType, NameType>[]

  Returns the batch of jobs for this job if any.

  Returns JobPro<DataType, ReturnType, NameType>[]

  See

  • Job
  • bullmq!JobPro | JobPro

  Example

  
  
  Copy

log

• log(logRow: string): 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.

moveToCompleted

• moveToCompleted(
      returnValue: ReturnType,
      token: string,
      fetchNext?: boolean,
  ): Promise<void | 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<void | any[]>

  Returns the jobData of the next job in the waiting queue.

moveToFailed

• moveToFailed(
      err: Error,
      token: string,
      fetchNext?: boolean,
  ): Promise<void | any[]>

  Moves a job to the failed queue.

  Parameters

  • err: Error

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

  void

setAsFailed

• setAsFailed(err: Error): void

  Set job as failed. This method will set the current job instance as failed, it is useful when processing batches to mark a certain job in a batch as failed while completing the rest.

  Parameters

  • err: Error

    The error object to be associated with the job.

  Returns void

setBatch

• setBatch(jobs: JobPro<DataType, ReturnType, NameType>[]): void

  Sets a batch of jobs for this job.

  Parameters

  • jobs: JobPro<DataType, ReturnType, NameType>[]

  Returns void

StaticaddJobLog

• addJobLog(
      queue: MinimalQueuePro,
      jobId: string,
      logRow: string,
      keepLogs?: number,
  ): Promise<number>

  addJobLog

  Parameters

  • queue: MinimalQueuePro

    A minimal queue instance

  • jobId: string

    Job id

  • logRow: string

    String with a row of log data to be logged

  • OptionalkeepLogs: number

    The optional amount of log entries to preserve

  Returns Promise<number>

  The total number of log entries for this job so far.

StaticfromJob

• fromJob<DataType = any, ResultType = any, NameType extends string = string>(
      queue: MinimalQueuePro,
      job: Job,
  ): JobPro<DataType, ResultType, NameType>

  Instantiates a JobPro instance based on a standard Job instance.

  Type Parameters

  • DataType = any
  • ResultType = any
  • NameType extends string = string

  Parameters

  • queue: MinimalQueuePro
  • job: Job

  Returns JobPro<DataType, ResultType, NameType>

StaticfromJSON

• fromJSON<T = any, R = any, N extends string = string>(
      queue: MinimalQueuePro,
      json: JobProJsonRaw,
      jobId?: string,
  ): JobPro<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: MinimalQueuePro

    the queue where the job belongs to.

  • json: JobProJsonRaw

    the plain object containing the job.

  • OptionaljobId: string

    an optional job id (overrides the id coming from the JSON object)

  Returns JobPro<T, R, N>