API reference / @evolu/common / Evolu/Owner / WriteKey

Variable: WriteKey

const WriteKey: BrandType<
  BrandType<
    Type<
      "Uint8Array",
      Uint8Array<ArrayBufferLike>,
      Uint8Array<ArrayBufferLike>,
      Uint8ArrayError,
      Uint8Array<ArrayBufferLike>,
      Uint8ArrayError
    >,
    `Length${number & Brand<"Int"> & Brand<"NonNegative">}`,
    LengthError<number & Brand<"Int"> & Brand<"NonNegative">>,
    Uint8ArrayError
  >,
  "WriteKey",
  BrandWithoutRefineError<
    "WriteKey",
    Uint8ArrayError | LengthError<number & Brand<"Int"> & Brand<"NonNegative">>
  >,
  never
>;

Defined in: packages/common/src/Evolu/Owner.ts:84

A secure token proving that the initiator can write changes. Derived from a mnemonic or randomly generated via createWriteKey. It is rotatable.