DeadLetterQueueOptionsType

DeadLetterQueueOptionsType = object

Defined in: src/deadletters/DeadLetterQueueOptions.ts:90

Plain options-object shape consumed by a DeadLetterQueue.

Properties

maxEntries?

readonly optional maxEntries?: number

Defined in: src/deadletters/DeadLetterQueueOptions.ts:100

Most letters the queue holds. Capturing the oldest one past the cap evicts it — the queue is a diagnostic ring, and an unbounded one turns a delivery outage into an out-of-memory.

Ignored by the off and metrics stores, which hold no letters.

---

maxReplays?

readonly optional maxReplays?: number

Defined in: src/deadletters/DeadLetterQueueOptions.ts:104

Refuse to replay a letter that has already come back this many times.

---

persistenceId?

readonly optional persistenceId?: string

Defined in: src/deadletters/DeadLetterQueueOptions.ts:109

Journal stream the persistent store writes to. Defaults to defaultDeadLetterPersistenceId over the system name.

---

retentionMs?

readonly optional retentionMs?: number

Defined in: src/deadletters/DeadLetterQueueOptions.ts:102

Drop letters older than this many milliseconds. 0 disables ageing.

---

store?

readonly optional store?: DeadLetterStore

Defined in: src/deadletters/DeadLetterQueueOptions.ts:92

Where captured letters are kept. Defaults to DEFAULT_DEAD_LETTER_STORE.