API Reference / @evolu/common / Evolu/Protocol / Storage
Interface: Storage
Defined in: packages/common/src/Evolu/Protocol.ts:199
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
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
findLowerBound | readonly | (ownerId, begin, end, upperBound) => | null | number & Brand<"Int"> & Brand<"NonNegative"> | - | packages/common/src/Evolu/Protocol.ts:221 |
fingerprint | readonly | (ownerId, begin, end) => | null | Fingerprint | - | packages/common/src/Evolu/Protocol.ts:202 |
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:215 |
getSize | readonly | (ownerId) => | null | number & Brand<"Int"> & Brand<"NonNegative"> | - | packages/common/src/Evolu/Protocol.ts:200 |
iterate | readonly | (ownerId, begin, end, callback) => void | - | packages/common/src/Evolu/Protocol.ts:228 |
readDbChange | readonly | (ownerId, timestamp) => | null | EncryptedDbChange | Read encrypted DbChanges from storage. | packages/common/src/Evolu/Protocol.ts:253 |
validateWriteKey | readonly | (ownerId, writeKey) => boolean | Authorizes the initiator's WriteKey for the given BinaryOwnerId. For a client that does not expect foreign writes, return false. | packages/common/src/Evolu/Protocol.ts:241 |
writeMessages | readonly | (ownerId, messages) => boolean | Write encrypted CrdtMessages to storage. | packages/common/src/Evolu/Protocol.ts:247 |