Skip to main content

EventEnvelope

@hardkas/core


@hardkas/core / EventEnvelope

Interface: EventEnvelope<K>

Defined in: packages/core/src/events.ts:149

Formal Event Envelope (v1).

Standardizes how events are captured and tracked across the system.

Type Parameters​

K​

K extends EventKind = EventKind

Properties​

artifactId?​

optional artifactId?: ArtifactId

Defined in: packages/core/src/events.ts:167


causationId?​

optional causationId?: EventId

Defined in: packages/core/src/events.ts:165


correlationId​

correlationId: CorrelationId

Defined in: packages/core/src/events.ts:164


domain​

domain: EventDomain

Defined in: packages/core/src/events.ts:154


emittedAt​

emittedAt: string

Defined in: packages/core/src/events.ts:158


eventId​

eventId: EventId

Defined in: packages/core/src/events.ts:153


globalOffset?​

optional globalOffset?: number

Defined in: packages/core/src/events.ts:160


kind​

kind: K

Defined in: packages/core/src/events.ts:155


networkId​

networkId: NetworkId

Defined in: packages/core/src/events.ts:169


payload​

payload: EventPayloadByKind[K]

Defined in: packages/core/src/events.ts:171


schema​

schema: "hardkas.event"

Defined in: packages/core/src/events.ts:150


sequenceNumber​

sequenceNumber: EventSequence

Defined in: packages/core/src/events.ts:159


sourceSubsystem​

sourceSubsystem: string

Defined in: packages/core/src/events.ts:161


timestamp​

timestamp: string

Defined in: packages/core/src/events.ts:157


txId?​

optional txId?: TxId

Defined in: packages/core/src/events.ts:168


version​

version: "1.0.0"

Defined in: packages/core/src/events.ts:151


workflowId​

workflowId: WorkflowId

Defined in: packages/core/src/events.ts:163