Skip to content
v9.1.1
Français

QueueWorkerOptions

import type { QueueWorkerOptions } from "@elie-laloum/outpost";

Parameters and properties

Section titled “Parameters and properties”
  • queueRequired
    TaskQueue
    Queue the worker claims jobs from and reports results to.
  • workerRequired
    string
    Worker name recorded on each claimed job, 1 to 512 characters; give each process its own.
  • handlersRequired
    Readonly<Record<string, QueueHandler>>
    Handlers by name, 1 to 100; the worker claims only jobs whose handler is listed here.
  • signalRequired
    AbortSignal
    Stops the worker: runQueueWorker() resolves and the running handler’s signal aborts. That job stays active until its lease expires.
  • leaseMsOptional
    number | undefined
    Lease duration in milliseconds, default 30000, from 30 to 300000; renewed at every third of it.
  • pollMsOptional
    number | undefined
    Wait in milliseconds after finding no eligible job, default 250; must be positive.

Signature

Section titled “Signature”
export interface QueueWorkerOptions {
  readonly queue: TaskQueue;
  readonly worker: string;
  readonly handlers: Readonly<Record<string, QueueHandler>>;
  readonly signal: AbortSignal;
  readonly leaseMs?: number;
  readonly pollMs?: number;
}
Section titled “Related contracts”