Class JobPro<DataType, ReturnType, NameType>

constructor

• new JobPro<DataType = any, ReturnType = any, NameType extends string = string>(
      queue: MinimalQueue,
      name: NameType,
      data: DataType,
      opts?: JobsProOptions,
      id?: string,
  ): JobPro<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: 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<any, any, string>[]

  Returns the batch of jobs for this job if any.

  Returns JobPro<any, any, string>[]

  See

  • Job
  • bullmq!JobPro | JobPro

  Example

  
  
  Copy

moveToCompleted

• moveToCompleted(
      returnValue: ReturnType,
      token: string,
      fetchNext?: boolean,
  ): 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.

moveToFailed

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

  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>

  void

moveToWaitingChildren

• moveToWaitingChildren(
      token: string,
      opts?: MoveToWaitingChildrenOpts,
  ): 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

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<any, any, string>[]): void

  Sets a batch of jobs for this job.

  Parameters

  • jobs: JobPro<any, any, string>[]

  Returns void

StaticfromJob

• fromJob<DataType = any, ResultType = any, NameType extends string = string>(
      queue: MinimalQueue,
      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: MinimalQueue
  • job: Job

  Returns JobPro<DataType, ResultType, NameType>

StaticfromJSON

• fromJSON<T = any, R = any, N extends string = string>(
      queue: MinimalQueue,
      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: MinimalQueue

    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>