Axinom Mosaic Libraries
    Preparing search index...

    Interface MessageEnvelope<TContent>

    Message envelope wrapping messages moving in the Axinom ecosystem.

    interface MessageEnvelope<TContent = unknown> {
        aggregate_id: string;
        aggregate_type: string;
        auth_token?: string;
        message_context?: unknown;
        message_id: string;
        message_type: string;
        message_version: string;
        payload: TContent;
        timestamp: string;
    }

    Type Parameters

    • TContent = unknown
    Index

    Properties

    aggregate_id aggregate_type auth_token? message_context? message_id message_type message_version payload timestamp

    Properties

    aggregate_id: string

    The unique identifier of the aggregate

    aggregate_type: string

    The type of the aggregate (in DDD context) or entity for which this message is sent

    auth_token?: string

    JWT token of the user/actor who triggered message publication.

    message_context?: unknown

    Optional contextual info for the payload consumer to send back with a response command or event.

    message_id: string

    Message's unique identifier.

    message_type: string

    Type of the message e.g. ContentPublishEvent

    message_version: string

    Version of the format of the payload field.

    payload: TContent

    Message payload.

    timestamp: string

    Time and date (UTC) when the message was published.

    Settings

    Member Visibility

    On This Page

    Properties