Class Job<JobOptions, JobReturnType>

constructor

• new Job<JobOptions, JobReturnType>(fn, options): Job<JobOptions, JobReturnType>

• Type Parameters

  • JobOptions extends AbortOptions = AbortOptions
  • JobReturnType = unknown

  Parameters

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

      • Parameters

        • options: JobOptions

        Returns Promise<JobReturnType>

  • options: any

  Returns Job<JobOptions, JobReturnType>

fn

id

options

recipients

status

Readonly timeline

abort

• abort(err): void

• Parameters

  • err: Error

  Returns void

cleanup

• cleanup(): void

• Returns void

join

• join(options?): Promise<JobReturnType>

• Parameters

  • options: AbortOptions = {}

  Returns Promise<JobReturnType>

onAbort

• onAbort(): void

• Returns void

run

• run(): Promise<void>

• Returns Promise<void>