API reference / @evolu/common / local-first/Protocol / ApplyProtocolMessageAsRelayResult

Interface: ApplyProtocolMessageAsRelayResult

Defined in: packages/common/src/local-first/Protocol.ts:1049

Result type for applyProtocolMessageAsRelay.

Unlike ApplyProtocolMessageAsClientResult, relays always respond with a message to provide sync completion feedback. This ensures the initiator can reliably detect when synchronization is complete, even when there's nothing to sync. Clients may choose not to respond in certain cases (like when they receive broadcast messages or when they lack a write key for syncing).

Properties

PropertyModifierTypeDefined in
messagereadonlyProtocolMessagepackages/common/src/local-first/Protocol.ts:1051
typereadonly"response"packages/common/src/local-first/Protocol.ts:1050

Was this page helpful?