ws-asyncapi API / core / BackplaneMessage

Interface: BackplaneMessage

Defined in: .api-entries/core/index.d.ts:293

A message delivered to a node for local fan-out.

Properties

topic

topic: string

Defined in: .api-entries/core/index.d.ts:294

---

payload

payload: string | Uint8Array<ArrayBufferLike>

Defined in: .api-entries/core/index.d.ts:296

already codec-encoded frame, ready to hand to the server's publish

---

origin

origin: string

Defined in: .api-entries/core/index.d.ts:298

node id that originated the message (skip when it equals our nodeId)

---

offset?

optional offset?: string | number

Defined in: .api-entries/core/index.d.ts:300

monotonic, cluster-wide offset, when the backplane supports replay

---

except?

optional except?: string[]

Defined in: .api-entries/core/index.d.ts:302

socket ids to skip on local delivery (e.g. exclude the sender)