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

Interface: Storage

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

Evolu Protocol Storage

The protocol is agnostic to storage implementation details—any storage can be plugged in, as long as it implements this interface. Implementations must handle their own errors; return values only indicates overall success or failure.

Extended by

• ClientStorage

Properties

Property	Modifier	Type	Description	Defined in
deleteOwner	readonly	(ownerId) => boolean	Delete all data for the given Owner.	packages/common/src/Evolu/Protocol.ts:304
findLowerBound	readonly	(ownerId, begin, end, upperBound) => | null | number & Brand<"Int"> & Brand<"NonNegative">	-	packages/common/src/Evolu/Protocol.ts:268
fingerprint	readonly	(ownerId, begin, end) => | null | Fingerprint	-	packages/common/src/Evolu/Protocol.ts:249
fingerprintRanges	readonly	(ownerId, buckets, upperBound?) => | null | readonly FingerprintRange[]	Computes fingerprints with their upper bounds in one call. This function can be replaced with many fingerprint/findLowerBound calls, but implementations can leverage it for batching and more efficient fingerprint computation.	packages/common/src/Evolu/Protocol.ts:262
getSize	readonly	(ownerId) => | null | number & Brand<"Int"> & Brand<"NonNegative">	-	packages/common/src/Evolu/Protocol.ts:247
iterate	readonly	(ownerId, begin, end, callback) => void	-	packages/common/src/Evolu/Protocol.ts:275
readDbChange	readonly	(ownerId, timestamp) => | null | EncryptedDbChange	Read encrypted DbChanges from storage.	packages/common/src/Evolu/Protocol.ts:298
setWriteKey	readonly	(ownerId, writeKey) => boolean	Sets the WriteKey for the given Owner.	packages/common/src/Evolu/Protocol.ts:289
validateWriteKey	readonly	(ownerId, writeKey) => boolean	Validates the WriteKey for the given Owner.	packages/common/src/Evolu/Protocol.ts:283
writeMessages	readonly	(ownerId, messages) => boolean	Write encrypted CrdtMessages to storage.	packages/common/src/Evolu/Protocol.ts:292