cap-nodejs

CAP Node.js API

---

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

Interface: CapPublishEvent<T>

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

Outbox message as seen by CAP core and storage/transport adapters.

Extends

• CapBaseMessage<T>

Type Parameters

T

T = JsonValue

Properties

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-publish-event.ts:19

---

lockedBy?

optional lockedBy?: string | null

Defined in: cap-core/src/models/cap-publish-event.ts:20

---

lockedUntil?

optional lockedUntil?: Date | null

Defined in: cap-core/src/models/cap-publish-event.ts:21

---

nextRetryAt?

optional nextRetryAt?: Date | null

Defined in: cap-core/src/models/cap-publish-event.ts:18

---

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

---

publishedAt?

optional publishedAt?: Date | null

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

---

retryCount

retryCount: number

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

How many times the publish logic retried this record.

---

status

status: CapPublishStatus

Defined in: cap-core/src/models/cap-publish-event.ts:17

---

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

This site is open source. Improve this page.