interface BackplaneCommonOptions

Options shared by every transport arm.

Properties

Since 0.2.0
readonly
optional
localNotice: boolean

M70n X3-4: when the resolved transport is 'memory', the plugin logs a process-local notice at register() — frames fan out only within this process, which looks like partial delivery behind more than one replica. Default true; false suppresses the notice, matching the existing scalingNotice opt-out shape on the SSE and WebSocket plugins.

readonly
optional
topic: string

The broker topic / Redis channel every instance publishes and subscribes on. Defaults to 'setu-ts.realtime'. Instances must agree on it to see each other.

readonly
optional
origin: string

This instance's identity, stamped on published frames so a subscriber can drop its own echoes. Defaults to a fresh runtime.uuid(), which is correct for every deployment; override only to make a test deterministic.

Usage

import { type BackplaneCommonOptions } from "realtime-backplane-plugin/src/index.ts";