Class JobQueue<R>

An in-memory queue with bounded concurrency and retention. Await each job.done to observe its result.

Type Parameters

R = unknown

Index

Constructors

Methods

Constructors

constructor

new JobQueue<R = unknown>(opts?: QueueOptions): JobQueue<R>
Create an instance with the supplied configuration; omitted fields use the documented defaults.
Type Parameters
- R = unknown
Parameters
- opts: QueueOptions = {}
Returns JobQueue<R>
- Defined in packages/jobs/src/queue.ts:41

Methods

add

add(
    functionName: string,
    task: (
        ctx: { signal: AbortSignal; stage: (stage: string) => void },
    ) => Promise<R>,
    fields?: Record<string, unknown>,
): Job<R>
Queue task as a job of functionName. The task gets an AbortSignal and a stage setter for progress; its return value is the job's result.
Parameters
- functionName: string
- task: (ctx: { signal: AbortSignal; stage: (stage: string) => void }) => Promise<R>
- fields: Record<string, unknown> = {}
Returns Job<R>
- Defined in packages/jobs/src/queue.ts:47

get

get(id: string): Job<R> | undefined
Look up a retained job by ID; returns undefined when unknown or dropped.
Parameters
- id: string
Returns Job<R> | undefined
- Defined in packages/jobs/src/queue.ts:81

list

list(): JobRecord[]
Return the current records for all retained jobs, including pending and finished jobs.

Returns JobRecord[]
- Defined in packages/jobs/src/queue.ts:86