Class LocalMessageBus

In-process MessageBus that delivers messages synchronously to local subscribers.

Remarks

Suitable for single-process deployments and tests; messages are not propagated across processes or hosts. During publish the subscriber set is snapshotted, so handlers may subscribe or unsubscribe without disturbing the current delivery. Although the method is async, delivery to handlers happens synchronously before the returned promise resolves.

Example

const bus = new LocalMessageBus()
const off = bus.subscribe('room:1', (msg) => console.log(msg))
await bus.publish('room:1', { type: 'joined', peer: 'p1' })
off() // stop receiving

Implements

MessageBus

Index

Constructors

constructor

Methods

publish subscribe

Constructors

constructor

new LocalMessageBus(
onError?: (err: unknown, topic: string) => void,
): LocalMessageBus
Parameters
- OptionalonError: (err: unknown, topic: string) => void
  Invoked when a subscriber throws. Delivery continues to the remaining subscribers regardless. Defaults to console.error.
Returns LocalMessageBus
- Defined in packages/core/src/MessageBus.ts:57

Methods

publish

publish(topic: string, message: unknown): Promise<void>
Publishes message to all current subscribers of topic.
Parameters
- topic: string
  The topic to publish on.
- message: unknown
  The payload to deliver to subscribers.
Returns Promise<void>
Implementation of MessageBus.publish
- Defined in packages/core/src/MessageBus.ts:65

subscribe(topic: string, handler: (message: unknown) => void): Unsubscribe
Subscribes handler to topic.
Parameters
- topic: string
  The topic to subscribe to.
- handler: (message: unknown) => void
  Callback invoked with each message published to the topic.
Returns Unsubscribe
An Unsubscribe function that removes this subscription when called.
Implementation of MessageBus.subscribe
- Defined in packages/core/src/MessageBus.ts:80

Class LocalMessageBus

Remarks

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns LocalMessageBus

Methods

publish

Parameters

Returns Promise<void>

Parameters

Returns Unsubscribe

Settings

On This Page