Skip to content

DeadLetterStore

Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:103

A transport that also keeps its records, so they can be listed, redriven with DeadLetterRedriver, and resolved. PostgresDeadLetterTransport implements it; queue transports rely on their broker’s own dead-letter tooling.

claim(id, leaseMs): Promise<boolean>

Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:117

Takes the open record for one redrive, in one atomic step, so that two redrives of one record cannot both dispatch it. The claim ends with recordAttempt or markResolved, or after leaseMs, which frees the record of a process that stopped during the handling.

string

number

How long the claim holds, in milliseconds.

Promise<boolean>

false when the record is absent, resolved or claimed.


get(id): Promise<DeadLetterRecord | undefined>

Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:105

The record with this id, or undefined.

string

Promise<DeadLetterRecord | undefined>


list(filter?): Promise<DeadLetterRecord[]>

Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:107

Records matching the filter, oldest first.

DeadLetterListFilter

Promise<DeadLetterRecord[]>


markResolved(id): Promise<void>

Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:121

Closes the record.

string

Promise<void>


recordAttempt(id, error): Promise<void>

Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:119

Counts one failed redrive attempt, keeps its error and ends the claim.

string

DeadLetterError

Promise<void>


send(record): Promise<void>

Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:85

Persist / publish a single dead-letter record.

Implementations should be resilient and fast; a throw here is caught by the behavior and logged, but never masks the original handler error.

DeadLetterRecord

The failed request snapshot to forward.

Promise<void>

DeadLetterTransport.send