Skip to main content

createEventEnvelope

@hardkas/core

@hardkas/core / createEventEnvelope

Function: createEventEnvelope()

createEventEnvelope<K>(params): EventEnvelope<K>

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

Creates a formal event envelope with required metadata.

Type Parameters​

K​

K extends EventKind

Parameters​

params​

artifactId?​

ArtifactId

causationId?​

EventId

correlationId​

CorrelationId

domain​

EventDomain

eventId?​

EventId

globalOffset?​

number

kind​

K

networkId​

NetworkId

payload​

EventPayloadByKind[K]

sequenceNumber​

EventSequence

sourceSubsystem​

string

txId?​

TxId

workflowId​

WorkflowId

Returns​

EventEnvelope<K>