Magek Framework
    Preparing search index...

    Interface EventEnvelope

    An Envelope carries a command/event body together with the name of its class. This is important information for the Distributor to work. Each runtime has to implement their own Envelope.

    interface EventEnvelope {
        currentUser?: UserEnvelope;
        requestID: UUID;
        context?: ContextEnvelope;
        typeName: string;
        version: number;
        superKind: SuperKindType;
        entityID: UUID;
        entityTypeName: string;
        value: EntityInterface | EventInterface | NotificationInterface;
        kind: "event";
        id?: string;
        createdAt: string;
        deletedAt?: string;
        processedAt?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    currentUser? requestID context? typeName version superKind entityID entityTypeName value kind id? createdAt deletedAt? processedAt?

    Properties

    currentUser?: UserEnvelope
    requestID: UUID
    context?: ContextEnvelope
    typeName: string
    version: number
    superKind: SuperKindType
    entityID: UUID
    entityTypeName: string
    value: EntityInterface | EventInterface | NotificationInterface
    kind: "event"
    id?: string

    Unique identifier assigned by the event store after persistence.

    createdAt: string

    ISO timestamp when the event was created.

    deletedAt?: string

    ISO timestamp when the event was soft-deleted, if applicable.

    processedAt?: string

    ISO timestamp when the event was processed by async event processing. Used for filtering unprocessed events and as an audit marker.

    Settings

    Member Visibility

    On This Page

    Properties