Class JobPro<DataType, ReturnType, NameType>

Type Parameters

DataType = any
ReturnType = any
NameType extends string = string

Hierarchy

Job<DataType, ReturnType, NameType>
- JobPro

Index

Constructors

Methods

moveToCompleted moveToFailed

Constructors

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>
Overrides Job<DataType, ReturnType, NameType>.constructor
- Defined in classes/job-pro.ts:24

Methods

moveToCompleted

moveToCompleted(
    returnValue: ReturnType,
    token: string,
    fetchNext?: boolean,
): Promise<JobData | []>
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<JobData | []>
Returns the jobData of the next job in the waiting queue.
Overrides Job.moveToCompleted
- Defined in classes/job-pro.ts:55

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
Overrides Job.moveToFailed
- Defined in classes/job-pro.ts:89