guide · queue

Every option, with its default.

The complete per-job option surface, what each field changes, and what you get when you leave it out.

Job Options Reference

Pass options with each add. The field names follow the host language while the broker receives the same values:

Bun

await queue.add('report', data, {
  priority: 10,
  delay: 5000,
  attempts: 5,
  jobId: 'report-42',
  durable: true,
});

Node.js / Deno

await queue.add('report', data, {
  priority: 10,
  delay: 5000,
  attempts: 5,
  jobId: 'report-42',
  durable: true,
});

Python

queue.add(
    "report", data,
    priority=10,
    delay=5000,
    attempts=5,
    job_id="report-42",
    durable=True,
)

PHP

$queue->add('report', $data, [
    'priority' => 10,
    'delay' => 5000,
    'attempts' => 5,
    'jobId' => 'report-42',
    'durable' => true,
]);

Go

queue.Add("report", data, bunqueue.JobOptions{
    "priority": 10,
    "delay": 5000,
    "attempts": 5,
    "jobId": "report-42",
    "durable": true,
})

Rust

queue.add("report", data, JobOptions {
    priority: Some(10),
    delay: Some(5000),
    attempts: Some(5),
    job_id: Some("report-42".into()),
    durable: Some(true),
    ..Default::default()
})?;

Elixir

{:ok, _job} =
  Bunqueue.Queue.add(queue, "report", data,
    priority: 10,
    delay: 5000,
    attempts: 5,
    jobId: "report-42",
    durable: true
  )

Python uses snake_case keyword arguments and Rust uses snake_case struct fields. Go uses a JobOptions map; PHP and Elixir use the camelCase protocol names shown in the table.

Option	Type	Default	Description
priority	number	0	Higher = processed first
delay	number	0	Delay in ms before processing
attempts	number	3	Max retry attempts
backoff	number | { type, delay }	1000	Backoff base in ms, or { type: 'fixed' | 'exponential', delay }
timeout	number	-	Processing timeout in ms
jobId	string	-	Custom ID for idempotent adds
deduplication	object	-	TTL-based dedup (id, ttl, extend, replace)
removeOnComplete	boolean	false	Auto-delete after completion
removeOnFail	boolean	false	Auto-delete after failure
stallTimeout	number	-	Per-job stall timeout override
repeat	object	-	Repeating job config (every, pattern, limit)
durable	boolean	false	Write to disk before returning
lifo	boolean	false	Process newest first
parent	{ id, queue }	-	Parent job reference for flows

At the same priority, LIFO jobs run newest-first ahead of FIFO jobs. Priority always remains authoritative, so a lower-priority LIFO job cannot overtake a higher-priority FIFO job.

Processing timeout values are measured from the active transition and use an absolute next-deadline timer. Concurrent jobs retain their individual deadlines. The broker’s timeout transition is authoritative: a processor outcome that arrives afterward is ignored for that exact lease generation, without emitting a contradictory local Worker event. A later retry uses a new lease and is not suppressed.

parent creates a real dependency edge to an existing pending job. The parent moves to waiting-children, runs only after every linked child finishes, and exposes child results through getChildrenValues(). This works across queues and is committed atomically in both embedded and TCP modes, including addBulk(). A missing, active, completed, or failed parent rejects the child; the rejected child is not left in memory or SQLite. Use FlowProducer when the parent and children must all be created as one new graph.

Related Guides

• Worker API, process jobs from queues
• Dead Letter Queue, handle failed jobs
• Rate Limiting, control processing rates
• Queue Group, manage multiple queues

Where to go next

Queue API	Create a queue in embedded or TCP mode
Adding Jobs	add, addBulk, priorities, delays, durability
Deduplication and Idempotent Job Adds	Idempotent adds, dedup keys, custom job ids
Querying Jobs	Fetch jobs, states, counts and results
Queue Control and Maintenance	Pause, drain, obliterate, clean and repair
Progress, Job Logs and Dependencies	Progress, per-job logs and dependencies
Queue Rate Limiting and Global Concurrency	Rate limits and global concurrency caps
Job Schedulers from the Queue	Named repeatable schedules from the queue
DLQ Operations from the Queue Object	Failed-job operations from the Queue object
Workers, Stats and Metrics from the Queue	Registered workers, stats and metrics windows
Namespaces, Auto-Batching and Store-and-Forward	Namespaces, auto-batching, store-and-forward