basalt / queue/src / QueueManagerOptions

Interface: QueueManagerOptions

Defined in: queue/src/manager.ts:162

Properties

onUnsupported?

> optional onUnsupported?: UnsupportedPolicy

Defined in: queue/src/manager.ts:164

Reaction when a job uses an option the driver can't honor. Default 'warn'.

---

removeOnComplete?

> optional removeOnComplete?: JobRetention

Defined in: queue/src/manager.ts:168

Default retention for completed jobs (a job can override). Driver default: keep 1000.

---

removeOnFail?

> optional removeOnFail?: JobRetention

Defined in: queue/src/manager.ts:170

Default retention for failed jobs (a job can override). Driver default: keep all.

---

signingKey?

> optional signingKey?: QueueSigningKey | readonly QueueSigningKey[]

Defined in: queue/src/manager.ts:181

HMAC-SHA256 key(s) that sign every dispatch envelope (job name + payload + context). With a key set, the worker REJECTS a job whose signature is missing or wrong (JobSignatureError) — so writing to the broker is no longer enough to run a job or to choose its tenant/user.

Pass an array to rotate: the FIRST key signs, every key verifies. Each key must be at least MIN_SIGNING_KEY_BYTES bytes. Producers and workers must share it. Without a key the broker is trusted (see the queues guide).

---

validateTenantId?

> optional validateTenantId?: (id) => boolean

Defined in: queue/src/manager.ts:187

Tenant-id grammar the worker accepts from an envelope's context. Default: @basaltkit/tenancy's default grammar. A job whose tenant id fails it is rejected (JobContextError), never run without its tenant.

Parameters

id

string

Returns

boolean

---

warn?

> optional warn?: (message) => void

Defined in: queue/src/manager.ts:166

Sink for 'warn' diagnostics. Default console.warn.

Parameters

message

string

Returns

void