Skip to main content

Interface: KVStore

Store defines a transactional key/value store that Replicache stores all data within.

For correct operation of Replicache, implementations of this interface must provide strict serializable transactions.

Informally, read and write transactions must behave like a ReadWrite Lock - multiple read transactions are allowed in parallel, or one write. Additionally writes from a transaction must appear all at one, atomically.

Properties​

closed​

closed: boolean


kind?​

readonly optional kind?: string

The kind of storage backing this store, e.g. 'idb' or 'mem'. This can change over time, for example when an IndexedDB store fails to open and falls back to memory.

Methods​

close()​

close(): Promise<void>

Returns​

Promise<void>


read()​

read(): Promise<KVRead>

Returns​

Promise<KVRead>


write()​

write(): Promise<KVWrite>

Returns​

Promise<KVWrite>