five-on-it / apps/api/src/queue / QueueOptions

Interface: QueueOptions

Defined in: apps/api/src/queue.ts:48

How a queue runs.

Properties

concurrency

concurrency: number

Defined in: apps/api/src/queue.ts:50

How many of its jobs this process runs at once; 0 runs none (they wait in the queue).

---

leaseMs?

optional leaseMs?: number

Defined in: apps/api/src/queue.ts:52

How long a claim holds a job without being renewed (ms; 60 s by default).

---

log?

optional log?: (message) => void

Defined in: apps/api/src/queue.ts:58

Hears what went wrong in the background (the store not answering).

Parameters

message

string

Returns

void

---

now?

optional now?: () => Date

Defined in: apps/api/src/queue.ts:56

The clock of the leases and the claims.

Returns

Date

---

pollMs?

optional pollMs?: number

Defined in: apps/api/src/queue.ts:54

How often the queue looks for work on its own once started (ms; 2 s by default).