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

Function: decryptAndDecodeDbChange()

function decryptAndDecodeDbChange(deps): (change, key) => Result<Readonly<{
  id: string & Brand<"Id">;
  table: string & Brand<"Base64Url"> & Brand<"MaxLength256">;
  values: Readonly<Record<string & Brand<"Base64Url"> & Brand<"MaxLength256">, null | string | number | Uint8Array<ArrayBufferLike>>>;
}>, 
  | SymmetricCryptoDecryptError
| ProtocolInvalidDataError>;

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

Decrypts and decodes an EncryptedDbChange using the provided owner's encryption key.

Parameters

Parameter	Type
`deps`	`SymmetricCryptoDep`

Returns

(change, key): Result<Readonly<{
  id: string & Brand<"Id">;
  table: string & Brand<"Base64Url"> & Brand<"MaxLength256">;
  values: Readonly<Record<string & Brand<"Base64Url"> & Brand<"MaxLength256">, null | string | number | Uint8Array<ArrayBufferLike>>>;
}>, 
  | SymmetricCryptoDecryptError
| ProtocolInvalidDataError>;

Parameters

Parameter	Type
`change`	`EncryptedDbChange`
`key`	`Uint8Array`<`ArrayBufferLike`> & `Brand`<`"Length32"`> & `Brand`<`"EncryptionKey"`>

Returns

Result<Readonly<{ id: string & Brand<"Id">; table: string & Brand<"Base64Url"> & Brand<"MaxLength256">; values: Readonly<Record<string & Brand<"Base64Url"> & Brand<"MaxLength256">, null | string | number | Uint8Array<ArrayBufferLike>>>; }>, | SymmetricCryptoDecryptError | ProtocolInvalidDataError>