Type Alias Start

Start: () => Promise<Stop>

Function type that starts the outbox consumer and returns a stop function.

When called, this function:

Checks MongoDB version compatibility
Ensures indexes are created
Loads or creates consumer state
Opens a Change Stream
Begins processing events

Type Declaration

- (): Promise<Stop>
- Returns Promise<Stop>
  Promise that resolves to a Stop function for graceful shutdown

Example

Basic start/stop

const outbox = createOutboxConsumer({ ... })

// Start consuming
const stop = await outbox.start()
console.log('Consumer started')

// Later, gracefully stop
await stop()
console.log('Consumer stopped')

Example

Automatic cleanup with shouldDisposeOnSigterm

const outbox = createOutboxConsumer({
  // ...
  shouldDisposeOnSigterm: true  // Default behavior
})

const stop = await outbox.start()
// Consumer will automatically stop on SIGTERM/SIGINT
// No need to manually call stop() in signal handlers

See

Stop - The returned shutdown function