# JobQueueOptions interface · @imqueue/job

Source: https://imqueue.org/api/job/latest/job.jobqueueoptions/
Published: 2026-07-31
Author: @imqueue maintainers (https://github.com/imqueue)
Package: @imqueue/job 3.0.3 — generated reference, not hand-written

Everything a job queue needs to connect and behave, given to every constructor in this package.

Only [JobQueueOptions.name](https://imqueue.org/api/job/latest/job.jobqueueoptions.name/) is required. The rest tune the broker connection, the delivery guarantee and logging, and each carries the default that applies when it is omitted.

**Signature:**

```typescript
export interface JobQueueOptions 
```

## Properties


| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [cluster?](https://imqueue.org/api/job/latest/job.jobqueueoptions.cluster/) |  | { host: string; port: number; }\[\] | _(Optional)_ Broker nodes to connect to, as host/port pairs. The broker is Redis. |
| [logger?](https://imqueue.org/api/job/latest/job.jobqueueoptions.logger/) |  | ILogger | _(Optional)_ Logger for the queue's own log and error messages. |
| [name](https://imqueue.org/api/job/latest/job.jobqueueoptions.name/) |  | string | Name of the job queue. Required. This is the queue's identity, not a label: a [JobQueueWorker](https://imqueue.org/api/job/latest/job.jobqueueworker/) and a [JobQueuePublisher](https://imqueue.org/api/job/latest/job.jobqueuepublisher/) that share a name are two ends of one queue, and two that do not are unrelated queues that will never see each other's jobs. |
| [password?](https://imqueue.org/api/job/latest/job.jobqueueoptions.password/) |  | string | _(Optional)_ Password for authenticating against the broker. |
| [prefix?](https://imqueue.org/api/job/latest/job.jobqueueoptions.prefix/) |  | string | _(Optional)_ Prefix for every key this queue creates in the broker. |
| [safe?](https://imqueue.org/api/job/latest/job.jobqueueoptions.safe/) |  | boolean | _(Optional)_ Whether a job is handed to a worker under a lock, so that a worker dying before it starts does not take the job with it. |
| [safeLockTtl?](https://imqueue.org/api/job/latest/job.jobqueueoptions.safelockttl/) |  | number | _(Optional)_ How long, in milliseconds, a job may sit checked out to a worker during safe delivery before it is treated as abandoned. |
| [username?](https://imqueue.org/api/job/latest/job.jobqueueoptions.username/) |  | string | _(Optional)_ Username for authenticating against the broker. Omit it on a broker that takes a password alone, which is the usual Redis setup. |
| [verbose?](https://imqueue.org/api/job/latest/job.jobqueueoptions.verbose/) |  | boolean | _(Optional)_ Enables the queue's informational tracing. |
| [verboseExtended?](https://imqueue.org/api/job/latest/job.jobqueueoptions.verboseextended/) |  | boolean | _(Optional)_ Adds message bodies to the verbose tracing. |