API reference / @evolu/common / Evolu/Internal / ClientStorage

Interface: ClientStorage

Defined in: packages/common/src/Evolu/Db.ts:1167

Common interface for both client and relay SQLite storages.

Extends

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
deleteOwnerreadonly(ownerId) => booleanDelete all data for the given Owner.Storage.deleteOwnerpackages/common/src/Evolu/Storage.ts:60
findLowerBoundreadonly(ownerId, begin, end, upperBound) => | null | number & Brand<"Int"> & Brand<"NonNegative">-Storage.findLowerBoundpackages/common/src/Evolu/Storage.ts:58
fingerprintreadonly(ownerId, begin, end) => | null | Fingerprint-Storage.fingerprintpackages/common/src/Evolu/Storage.ts:56
fingerprintRangesreadonly(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.Storage.fingerprintRangespackages/common/src/Evolu/Storage.ts:57
getSizereadonly(ownerId) => | null | number & Brand<"Int"> & Brand<"NonNegative">-Storage.getSizepackages/common/src/Evolu/Storage.ts:55
insertTimestampreadonly(ownerId, timestamp) => Result<void, SqliteError>-SqliteStorageBase.insertTimestamppackages/common/src/Evolu/Storage.ts:50
iteratereadonly(ownerId, begin, end, callback) => void-Storage.iteratepackages/common/src/Evolu/Storage.ts:59
readDbChangereadonly(ownerId, timestamp) => | null | EncryptedDbChangeRead encrypted DbChanges from storage.Storage.readDbChangepackages/common/src/Evolu/Protocol.ts:292
setWriteKeyreadonly(ownerId, writeKey) => booleanSets the WriteKey for the given Owner.Storage.setWriteKeypackages/common/src/Evolu/Protocol.ts:283
validateWriteKeyreadonly(ownerId, writeKey) => booleanValidates the WriteKey for the given Owner.Storage.validateWriteKeypackages/common/src/Evolu/Protocol.ts:277
writeMessagesreadonly(ownerId, messages) => booleanWrite encrypted CrdtMessages to storage.Storage.writeMessagespackages/common/src/Evolu/Protocol.ts:286

Was this page helpful?