Type Alias Publish<Message>`Template`

Publish: (
message: MessageEnvelope<Message> | MessageEnvelope<Message>[],
options?: PublishOptions,
) => Promise<void>

Function type for publishing messages to the outbox.

Message - The type of the domain message/event

Type Parameters

Message extends JSONValue

Type Declaration

- (
  message: MessageEnvelope<Message> | MessageEnvelope<Message>[],
  options?: PublishOptions,
  ): Promise<void>
- Parameters
  - message: MessageEnvelope<Message> | MessageEnvelope<Message>[]
    Single message or array of messages to publish
  - Optionaloptions: PublishOptions
    Optional PublishOptions for transaction and partitioning
  Returns Promise<void>
  Promise that resolves when message(s) are inserted into outbox table

Throws

If message insertion fails

Example

// Queue single message
await outbox.queue(event)

// Queue multiple messages atomically
await outbox.queue([event1, event2, event3])

// Queue with transaction for consistency
await sql.begin(async (sql) => {
  await db.updateInventory(item, sql)
  await outbox.queue(inventoryUpdatedEvent, { tx: sql })
})