Type Alias Stop

Stop: () => Promise<void>

Function type that stops the outbox consumer gracefully.

When called, this function:

Closes the Change Stream
Waits for in-flight events to complete
Cleans up resources

Type Declaration

- (): Promise<void>
- Returns Promise<void>
  Promise that resolves when consumer has fully stopped

Example

Manual shutdown

const stop = await outbox.start()

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

Example

Shutdown with timeout

const stop = await outbox.start()

process.on('SIGTERM', async () => {
  console.log('Shutting down...')

  const timeout = setTimeout(() => {
    console.error('Shutdown timeout, forcing exit')
    process.exit(1)
  }, 5000)

  await stop()
  clearTimeout(timeout)
  console.log('Shutdown complete')
})

See

Start - The function that returns this stop function