Type Alias Start

Start: (() => Promise<Stop>)

Function that runs an OutboxConsumer instance.

Type declaration

- (): Promise<Stop>
- Returns Promise<Stop>
  A function to stop the OutboxConsumer instance.

Example

const stop = await outbox.start()
// later...
// but remember it will happen automatically when `shouldDisposeOnSigterm` is set to `true`.
await stop()