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

Function: applyProtocolMessageAsRelay()

function applyProtocolMessageAsRelay(
  deps,
): (
  inputMessage,
  options,
  version,
) => Promise<
  Result<ApplyProtocolMessageAsRelayResult, ProtocolInvalidDataError>
>;

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

Parameters

ParameterType
depsStorageDep

Returns

(
   inputMessage,
   options,
version): Promise<Result<ApplyProtocolMessageAsRelayResult, ProtocolInvalidDataError>>;

Parameters

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

Returns

Promise<Result<ApplyProtocolMessageAsRelayResult, ProtocolInvalidDataError>>

Was this page helpful?