Interface IAsyncOutboxConsumer<Message>`Template`

Interface for the asynchronous outbox consumer.

Message - The type of domain messages/events

interface IAsyncOutboxConsumer<Message extends JSONValue> {
    send(
        message: MessageEnvelope<Message> | MessageEnvelope<Message>[],
        options: PublishOptions,
    ): Promise<void>;
    start(): Stop;
    stop(): Promise<void>;
}

Type Parameters

Message extends JSONValue

Implemented by

AsyncOutboxConsumer

Index

Methods

send start stop

Methods

send

send(
message: MessageEnvelope<Message> | MessageEnvelope<Message>[],
options: PublishOptions,
): Promise<void>
Sends a message or array of messages to the async outbox.
Parameters
- message: MessageEnvelope<Message> | MessageEnvelope<Message>[]
  Single message or array of messages
- options: PublishOptions
  Optional transaction for atomic operations
Returns Promise<void>
- Defined in packages/hermes-postgresql/src/asyncOutbox/AsyncOutboxConsumer.ts:117

start

start(): Stop
Starts the async outbox consumer polling loop.

Returns Stop
Stop function for graceful shutdown
- Defined in packages/hermes-postgresql/src/asyncOutbox/AsyncOutboxConsumer.ts:124

stop

stop(): Promise<void>
Stops the async outbox consumer.

Returns Promise<void>
- Defined in packages/hermes-postgresql/src/asyncOutbox/AsyncOutboxConsumer.ts:129

Interface IAsyncOutboxConsumer<Message>`Template`

Type Parameters

Implemented by

Index

Methods

Methods

send

Parameters

Returns Promise<void>

start

Returns Stop

stop

Returns Promise<void>

Settings

On This Page

Interface IAsyncOutboxConsumer<Message>Template

Type Parameters

Implemented by

Index

Methods

Methods

send

Parameters

Returns Promise<void>

start

Returns Stop

stop

Returns Promise<void>

Settings

On This Page

Interface IAsyncOutboxConsumer<Message>`Template`