Type Alias Stop

Stop: () => Promise<void>

Function type that stops the outbox consumer and cleans up resources.

This function:

Stops consuming from PostgreSQL Logical Replication
Waits for in-flight messages to complete
Closes database connections
Cleans up the replication slot

Type Declaration

- (): Promise<void>
- Returns Promise<void>
  Promise that resolves when shutdown is complete

Example

const stopOutbox = await outbox.start()

process.on('SIGTERM', async () => {
  await stopOutbox()
  process.exit(0)
})