API Reference / @evolu/common / Evolu/Protocol / applyProtocolMessageAsRelay

Function: applyProtocolMessageAsRelay()

function applyProtocolMessageAsRelay(deps): (inputMessage, options, version) => Result<
  | null
| ProtocolMessage, ProtocolInvalidDataError>;

Defined in: packages/common/src/Evolu/Protocol.ts:905

Parameters

ParameterType
depsStorageDep

Returns

(
   inputMessage, 
   options, 
   version): Result<
  | null
| ProtocolMessage, ProtocolInvalidDataError>;

Parameters

ParameterTypeDefault valueDescription
inputMessageUint8Arrayundefined-
optionsApplyProtocolMessageAsRelayOptions{}-
versionnumber & Brand<"Int"> & Brand<"NonNegative">protocolVersionFor testing purposes only; should not be used in production.

Returns

Result< | null | ProtocolMessage, ProtocolInvalidDataError>

Was this page helpful?