Connectum API Reference / @connectum/events / types / EventBusOptions
Interface: EventBusOptions
Defined in: packages/events/src/types.ts:296
EventBus configuration options for createEventBus()
Properties
adapter
adapter:
EventAdapter
Defined in: packages/events/src/types.ts:298
Adapter instance (e.g., NatsAdapter, KafkaAdapter, MemoryAdapter)
drainTimeout?
optionaldrainTimeout?:number
Defined in: packages/events/src/types.ts:327
Maximum time in milliseconds to wait for in-flight event handlers to complete during shutdown. After this timeout, remaining handlers are force-aborted via AbortSignal.
Default: 30000 (30 seconds). Set to 0 for immediate abort.
group?
optionalgroup?:string
Defined in: packages/events/src/types.ts:302
Consumer group name
handlerTimeout?
optionalhandlerTimeout?:number
Defined in: packages/events/src/types.ts:319
Per-event handler timeout in milliseconds.
Each event handler invocation gets an AbortSignal that fires after this duration. Default: 30000 (30 seconds).
middleware?
optionalmiddleware?:MiddlewareConfig
Defined in: packages/events/src/types.ts:304
Middleware configuration
routes?
optionalroutes?:EventRoute[]
Defined in: packages/events/src/types.ts:300
Event routes to register
signal?
optionalsignal?:AbortSignal
Defined in: packages/events/src/types.ts:312
Abort signal for graceful shutdown.
When provided, per-event signals are composed via AbortSignal.any() so that server shutdown aborts in-flight event processing. Automatically set when used with createServer({ eventBus }).
