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

Function: createProtocolMessageBuffer()

function createProtocolMessageBuffer(ownerId, options): ProtocolMessageBuffer;

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

Parameters

ParameterType
ownerIdstring & Brand<"Id"> & Brand<"OwnerId">
options{ errorCode?: ProtocolErrorCode; rangesMaxSize?: number & Brand<"Int"> & Brand<"NonNegative"> & Brand<"Positive">; totalMaxSize?: number & Brand<"Int"> & Brand<"NonNegative"> & Brand<"Positive">; version?: number & Brand<"Int"> & Brand<"NonNegative">; writeKey?: Uint8Array<ArrayBufferLike> & Brand<`Length${number & Brand<"Int"> & Brand<"NonNegative">}`> & Brand<"WriteKey">; }
options.errorCode?ProtocolErrorCode
options.rangesMaxSize?number & Brand<"Int"> & Brand<"NonNegative"> & Brand<"Positive">
options.totalMaxSize?number & Brand<"Int"> & Brand<"NonNegative"> & Brand<"Positive">
options.version?number & Brand<"Int"> & Brand<"NonNegative">
options.writeKey?Uint8Array<ArrayBufferLike> & Brand<`Length${number & Brand<"Int"> & Brand<"NonNegative">}`> & Brand<"WriteKey">

Returns

ProtocolMessageBuffer

Was this page helpful?