Skip to content

EventDeadLetterReport

Defined in: packages/server/src/events/consumer.ts:142

What DefineEventConsumerOptions.onDeadLetter is told about a sub-batch the runner gave up on.

attempts: number

Defined in: packages/server/src/events/consumer.ts:147

Deliveries this message had received. 0 when the body was unreadable (nothing was ever delivered from it).


optional cause?: unknown

Defined in: packages/server/src/events/consumer.ts:153

The error behind it: the callback’s throw, or the MalformedEventQueueMessageError.


optional message?: object

Defined in: packages/server/src/events/consumer.ts:151

The message, when it was readable. Absent for a malformed body (that is exactly what could not be parsed).

events: object[]

stream: string


reason: string

Defined in: packages/server/src/events/consumer.ts:145

Why it was dead-lettered — the same reason recorded in the backend’s dead-letter storage.


receipt: string

Defined in: packages/server/src/events/consumer.ts:149

The receipt it was dead-lettered under — always present, including for an unparseable body.


stream: string

Defined in: packages/server/src/events/consumer.ts:143