interface AddJobOptions
Since 0.1.0

Options accepted when enqueueing a job.

Properties

readonly
optional
delayMs: number

Delay before the job becomes available, in milliseconds.

readonly
optional
maxAttempts: number

Maximum attempts before the job is dead-lettered.

Since 0.5.0
readonly
optional
headers: Readonly<Record<string, string>>

Transport headers to carry with the job, delivered to the processor as IJob.headers.

Delivery does NOT depend on which capabilities are registered: a map passed here reaches the processor whether or not telemetry is present. With a CAPABILITIES.TELEMETRY provider the framework ADDS a W3C traceparent to whatever the caller supplied, so an enqueued job joins the trace of the request that enqueued it.

Usage

import { type AddJobOptions } from "queue-plugin/src/index.ts";