cap-nodejs

CAP Node.js API


CAP Node.js API / cap-core/src / CapReceivedEvent

Interface: CapReceivedEvent<T>

Defined in: cap-core/src/models/cap-received-event.ts:14

Message as observed on the subscriber side, after inbox persistence.

Extends

Type Parameters

T

T = JsonValue

Properties

dedupeKey

dedupeKey: string

Defined in: cap-core/src/models/cap-received-event.ts:22

Stable dedupe key; defaults to ${topic}|${group}|${messageId}.


group

group: string

Defined in: cap-core/src/models/cap-received-event.ts:16

Consumer group or queue that received the delivery.


headers?

optional headers?: CapHeaders

Defined in: cap-core/src/models/cap-base-message.ts:21

Optional key/value headers such as trace-id or saga-id.

Inherited from

CapBaseMessage.headers


id

id: string

Defined in: cap-core/src/models/cap-base-message.ts:9

Globally unique ID (UUID v4 recommended).

Inherited from

CapBaseMessage.id


lastError?

optional lastError?: string | null

Defined in: cap-core/src/models/cap-received-event.ts:34

Last handler error message, if processing failed.


messageId

messageId: string

Defined in: cap-core/src/models/cap-received-event.ts:19

Broker/source message id used for inbox deduplication.


nextRetry

nextRetry: Date | null

Defined in: cap-core/src/models/cap-received-event.ts:43

When this message becomes eligible for the next retry. null means the first attempt is still pending or the message is terminal.


occurredAt

occurredAt: string

Defined in: cap-core/src/models/cap-base-message.ts:15

UTC ISO string set by publisher, not the DB timestamp.

Inherited from

CapBaseMessage.occurredAt


payload

payload: T

Defined in: cap-core/src/models/cap-base-message.ts:18

User-defined payload. Keep it serializable.

Inherited from

CapBaseMessage.payload


processed

processed: boolean

Defined in: cap-core/src/models/cap-received-event.ts:31

True when handler completed successfully.


processedAt?

optional processedAt?: Date | null

Defined in: cap-core/src/models/cap-received-event.ts:37

When the handler completed successfully.


retryCount

retryCount: number

Defined in: cap-core/src/models/cap-received-event.ts:25

How many handler attempts so far.


status

status: CapReceivedStatus

Defined in: cap-core/src/models/cap-received-event.ts:28

Current inbox processing state.


topic

topic: string

Defined in: cap-core/src/models/cap-base-message.ts:12

Logical topic / exchange name, e.g. user.created.

Inherited from

CapBaseMessage.topic