Type Alias Outbox

install

• install(bus: AsyncCommandBus): void

  Convenience: bus.use(plugin, { priority: 200 }) + keep the bus ref for flush() / auto-flush.

  Parameters

  • bus: AsyncCommandBus

  Returns void

flush

• flush(
      bus?: AsyncCommandBus<CommandMap>,
  ): Promise<{ replayed: number; failed: number }>

  Replay the queue sequentially (strict FIFO). Each record is re-dispatched through the full pipeline with its ORIGINAL idempotency key stamped on cmd.meta.idempotencyKey, so the HTTP bridge sends the same Idempotency-Key the backend may have already seen. The first failed replay stops the flush — that record and everything after it stay queued. Re-entrant calls join the in-progress flush.

  Parameters

  • Optionalbus: AsyncCommandBus<CommandMap>

  Returns Promise<{ replayed: number; failed: number }>

hydrate

• hydrate(): Promise<void>

  Load the persisted queue from storage. Call once at startup, before the first flush.

  Returns Promise<void>

clear

• clear(): Promise<void>

  Drop every queued record (memory + storage).

  Returns Promise<void>

dispose

• dispose(): void

  Remove the window 'online' listener. Idempotent.

  Returns void

plugin

pending