Class OutboxConsumer<Message>

Type Parameters

Message extends JSONValue

Implements

IOutboxConsumer<Message>

Index

Constructors

Methods

getCreationParams getDbConnection queue send start

Constructors

constructor

new OutboxConsumer<Message extends JSONValue>(
    _params: ConsumerCreationParams<Message>,
    _createClient: (
        options: Options<Record<string, PostgresType<any>>>,
    ) => HermesSql,
    _state?: OutboxConsumerState,
): OutboxConsumer<Message>
Type Parameters
- Message extends JSONValue
Parameters
- _params: ConsumerCreationParams<Message>
- _createClient: (options: Options<Record<string, PostgresType<any>>>) => HermesSql
- Optional_state: OutboxConsumerState
Returns OutboxConsumer<Message>
- Defined in outbox/OutboxConsumer.ts:33

Methods

getCreationParams

getCreationParams(): ConsumerCreationParams<Message>
Returns ConsumerCreationParams<Message>
Implementation of IOutboxConsumer.getCreationParams
- Defined in outbox/OutboxConsumer.ts:39

getDbConnection

getDbConnection(): HermesSql
Returns HermesSql
Implementation of IOutboxConsumer.getDbConnection
- Defined in outbox/OutboxConsumer.ts:43

queue

queue(
message: MessageEnvelope<Message> | MessageEnvelope<Message>[],
options?: PublishOptions,
): Promise<void>
Parameters
- message: MessageEnvelope<Message> | MessageEnvelope<Message>[]
- Optionaloptions: PublishOptions
Returns Promise<void>
Implementation of IOutboxConsumer.queue
- Defined in outbox/OutboxConsumer.ts:179

send

send(
message: MessageEnvelope<Message> | MessageEnvelope<Message>[],
tx?: TransactionSql<{}>,
): Promise<void>
Parameters
- message: MessageEnvelope<Message> | MessageEnvelope<Message>[]
- Optionaltx: TransactionSql<{}>
Returns Promise<void>
Implementation of IOutboxConsumer.send
- Defined in outbox/OutboxConsumer.ts:202

start

start(): Promise<Stop>
Returns Promise<Stop>
Implementation of IOutboxConsumer.start
- Defined in outbox/OutboxConsumer.ts:48