Type Alias StoreOutboxMessage

Type Declaration

• • <T>(
        aggregateId: string,
        messagingSettings: Pick<
            MessagingSettings,
            "messageType"
            | "aggregateType"
            | "action",
        >,
        payload: T,
        client: DatabaseClient,
        optionalData?: StoreOutboxMessageAdditionalData,
    ): Promise<void>

  • Type Parameters

    • T

    Parameters

    • aggregateId: string

      The (database) ID of the aggregate type or use the const UNKNOWN_AGGREGATE_ID or MULTIPLE_AGGREGATE_IDS values.

    • messagingSettings: Pick<MessagingSettings, "messageType" | "aggregateType" | "action">

      The messaging related settings object

    • payload: T

      The payload of the message

    • client: DatabaseClient

      The database client to use to store the outbox message

    • OptionaloptionalData: StoreOutboxMessageAdditionalData

      Add additional data to the outbox message that is going to be stored

    Returns Promise<void>