REST SDK Queues
Access via rest.queues (IRestQueueManager). Wire JSON uses snake_case; the SDK exposes camelCase.
Jobs
| Method | Description |
|---|---|
enqueue(name, payload, opts?) | Create a job |
getJob(name, jobId) | Fetch one job |
listJobs(name, opts?) | List jobs (status filter) |
cancelJob(name, jobId) | Cancel |
retryJob(name, jobId) | Retry |
EnqueueOptions: delay, idempotencyKey, scheduleAt, metadata.
Config
| Method | Description |
|---|---|
getConfig(name) | Read queue config |
updateConfig(name, opts) | Create queue if missing (maxAttempts, webhooks); no field updates if it already exists |
See Jobs for current PUT behavior.
Workers
| Method | Description |
|---|---|
registerWorker({ name, queues }) | Register worker metadata |
heartbeat(workerId) | Heartbeat |
runWorker(name, handler, opts?) | Long-poll loop (blocks until stop) |
stopWorker() | Stop the loop |
RunWorkerOptions: workerId, batchSize, pollIntervalMs, wait.
Conceptual guide: Queue.