Interface IJobQueue<T>

Type Parameters

T extends Record<any, any>

Hierarchy

IJobQueue

Implemented by

JobQueue

Index

Properties

addJob addJobs init stop updateJob

Methods

Properties

addJob

addJob: ((job: Job<T>) => Promise<void>)

Type declaration

- (job: Job<T>): Promise<void>
- Parameters
  - job: Job<T>
  Returns Promise<void>

addJobs

addJobs: ((jobs: Job<T>[]) => Promise<void>)

Type declaration

- (jobs: Job<T>[]): Promise<void>
- Parameters
  - jobs: Job<T>[]
  Returns Promise<void>

init

init: ((workersByJob: Record<string, Worker<T>>) => Promise<void>)

Type declaration

- (workersByJob: Record<string, Worker<T>>): Promise<void>
- Parameters
  - workersByJob: Record<string, Worker<T>>
  Returns Promise<void>

stop

stop: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Returns Promise<void>

updateJob

updateJob: ((jobId: string, data: T) => Promise<void>)

Type declaration

- (jobId: string, data: T): Promise<void>
- Parameters
  - jobId: string
  - data: T
  Returns Promise<void>

Methods

getJobs

getJobs(state: JobState, jobTypes: string[]): Promise<Record<string, JobWithMetadata<T>[]>>
Parameters
- state: JobState
- jobTypes: string[]
Returns Promise<Record<string, JobWithMetadata<T>[]>>
- Defined in packages/job-queue/src/index.ts:38