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

Function: createProtocolMessageForWriteKeyRotation()

function createProtocolMessageForWriteKeyRotation(
   ownerId, 
   currentWriteKey, 
   newWriteKey): ProtocolMessage;

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

Creates a ProtocolMessage for WriteKey rotation.

Parameters

ParameterType
ownerIdstring & Brand<"Id"> & Brand<"OwnerId">
currentWriteKeyUint8Array<ArrayBufferLike> & Brand<`Length${number & Brand<"Int"> & Brand<"NonNegative">}`> & Brand<"WriteKey">
newWriteKeyUint8Array<ArrayBufferLike> & Brand<`Length${number & Brand<"Int"> & Brand<"NonNegative">}`> & Brand<"WriteKey">

Returns

ProtocolMessage

Was this page helpful?