Skip to content

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

Interface: EventAdapter

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

Minimal adapter interface for message brokers.

Inspired by Watermill (Go): minimal surface, broker-specific config in constructor, not in interface methods.

Properties

name

readonly name: string

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

Adapter name for identification (e.g., "nats", "kafka", "redis", "memory")

Methods

connect()

connect(context?): Promise<void>

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

Connect to the message broker.

Parameters

context?

AdapterContext

Optional adapter context with service-level information derived from proto service descriptors. Adapters may use context.serviceName for broker-level client identification.

Returns

Promise<void>


disconnect()

disconnect(): Promise<void>

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

Disconnect from the message broker

Returns

Promise<void>


publish()

publish(eventType, payload, options?): Promise<void>

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

Publish a serialized event to a topic

Parameters

eventType

string

payload

Uint8Array

options?

PublishOptions

Returns

Promise<void>


subscribe()

subscribe(patterns, handler, options?): Promise<EventSubscription>

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

Subscribe to event patterns with a raw handler

Parameters

patterns

string[]

handler

RawEventHandler

options?

RawSubscribeOptions

Returns

Promise<EventSubscription>