Class Job<JobOptions, JobReturnType>

constructor

• new Job<JobOptions extends AbortOptions = AbortOptions, JobReturnType = unknown>(
      fn: (options: JobOptions) => Promise<JobReturnType>,
      options: any,
  ): Job<JobOptions, JobReturnType>

  Type Parameters

  • JobOptions extends AbortOptions = AbortOptions
  • JobReturnType = unknown

  Parameters

  • fn: (options: JobOptions) => Promise<JobReturnType>
  • options: any

  Returns Job<JobOptions, JobReturnType>

fn

id

options

recipients

status

Readonlytimeline

abort

• abort(err: Error): void

  Parameters

  • err: Error

  Returns void

cleanup

• cleanup(): void

  Returns void

join

• join(options?: AbortOptions): Promise<JobReturnType>

  Parameters

  • options: AbortOptions = {}

  Returns Promise<JobReturnType>

onAbort

• onAbort(): void

  Returns void

run

• run(): Promise<void>

  Returns Promise<void>