Skip to main content

Crate nestrs_outbox

Crate nestrs_outbox 

Source
Expand description

NestJS @nestjs/outbox analogue — transactional outbox, relay, retries, and dead-letter queue.

§Flow

  1. OutboxRelay::add inside the same logical transaction as business writes.
  2. Background loop calls OutboxRelay::tick with a PublishFn.
  3. Success → published; failure → retry; after max_attempts → DLQ.

§Module

ⓘ
use nestrs_outbox::{OutboxModule, OutboxOptions};
let dm = OutboxModule::register(OutboxOptions::default());

Set allow_in_memory: false once a durable store adapter is configured. Pair with nestrs-webhooks for signed outbound delivery.

Umbrella feature: nestrs / outbox → nestrs::outbox.

Structs§

DeadLetter
DynamicModule
Runtime-composed module unit for conditional imports (feature flags, env switches, plugins).
InMemoryOutboxStore
OutboxMessage
OutboxModule
OutboxOptions
OutboxRelay
Relay pending outbox messages through a user-provided publisher.
ProviderRegistry

Enums§

OutboxStatus

Traits§

Injectable
Application service or provider type constructed through the DI container.
OutboxStore

Type Aliases§

PublishFn
SharedOutboxStore