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.
Extends
Section titled “Extends”Methods
Section titled “Methods”claim()
Section titled “claim()”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.
Parameters
Section titled “Parameters”string
leaseMs
Section titled “leaseMs”number
How long the claim holds, in milliseconds.
Returns
Section titled “Returns”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.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<DeadLetterRecord | undefined>
list()
Section titled “list()”list(
filter?):Promise<DeadLetterRecord[]>
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:107
Records matching the filter, oldest first.
Parameters
Section titled “Parameters”filter?
Section titled “filter?”Returns
Section titled “Returns”markResolved()
Section titled “markResolved()”markResolved(
id):Promise<void>
Defined in: packages/pipeline-deadletter/src/interfaces/dead-letter-transport.interface.ts:121
Closes the record.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
recordAttempt()
Section titled “recordAttempt()”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.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
send()
Section titled “send()”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.
Parameters
Section titled “Parameters”record
Section titled “record”The failed request snapshot to forward.
Returns
Section titled “Returns”Promise<void>