Appearance

Connectum API Reference / @connectum/events / types / EventBus

Interface: EventBus ​

Defined in: packages/events/src/types.ts:316

EventBus interface -- manages adapter, routes, and middleware

Methods ​

publish() ​

publish<Desc>(schema, data, options?): Promise<void>

Defined in: packages/events/src/types.ts:330

Publish a typed event

Type Parameters ​

Desc ​

Desc extends DescMessage

Parameters ​

schema ​

Desc

data ​

MessageShape<Desc>

options? ​

PublishOptions

Returns ​

Promise<void>

start() ​

start(options?): Promise<void>

Defined in: packages/events/src/types.ts:326

Start the event bus: connect adapter, set up subscriptions.

An optional signal can be passed for graceful shutdown. If provided, it overrides the construction-time EventBusOptions.signal. The active signal is then composed with AbortSignal.timeout(handlerTimeout) via AbortSignal.any() for each event handler invocation, so either shutdown or per-event timeout will abort in-flight processing.

Parameters ​

options? ​
signal? ​

AbortSignal

Returns ​

Promise<void>

stop() ​

stop(): Promise<void>

Defined in: packages/events/src/types.ts:328

Stop the event bus: drain subscriptions, disconnect adapter

Returns ​

Promise<void>