Class IndexedDBStorageAdapter

A storage adapter represents some way of storing binary data for a Repo

Remarks

StorageAdapters provide a key/value storage interface. The keys are arrays of strings (StorageKey) and the values are binary blobs.

Implements

StorageAdapterInterface

Index

Constructors

Methods

load loadRange remove removeRange save

Constructors

constructor

new IndexedDBStorageAdapter(database?, store?): IndexedDBStorageAdapter
Create a new IndexedDBStorageAdapter.
Parameters
- database: string = "automerge"
  The name of the database to use. Defaults to "automerge".
- store: string = "documents"
  The name of the object store to use. Defaults to "documents".
Returns IndexedDBStorageAdapter
- Defined in index.ts:20

Methods

load

load(keyArray): Promise<undefined | Uint8Array>
Load the single value corresponding to key
Parameters
- keyArray: string[]
Returns Promise<undefined | Uint8Array>
Implementation of StorageAdapterInterface.load
- Defined in index.ts:47

loadRange

loadRange(keyPrefix): Promise<Chunk[]>
Load all values with keys that start with keyPrefix.
Parameters
- keyPrefix: string[]
Returns Promise<Chunk[]>
Remarks
The keyprefix will match any key that starts with the given array. For example:
- [documentId, "incremental"] will match all incremental saves
- [documentId] will match all data for a given document.
Be careful! [documentId] would also match something like [documentId, "syncState"]! We aren't using this yet but keep it in mind.)
Implementation of StorageAdapterInterface.loadRange
- Defined in index.ts:104

remove

remove(keyArray): Promise<void>
Remove the value corresponding to key
Parameters
- keyArray: string[]
Returns Promise<void>
Implementation of StorageAdapterInterface.remove
- Defined in index.ts:87

removeRange

removeRange(keyPrefix): Promise<void>
Remove all values with keys that start with keyPrefix
Parameters
- keyPrefix: string[]
Returns Promise<void>
Implementation of StorageAdapterInterface.removeRange
- Defined in index.ts:135

save

save(keyArray, binary): Promise<void>
Save the value data to the key key
Parameters
- keyArray: string[]
- binary: Uint8Array
Returns Promise<void>
Implementation of StorageAdapterInterface.save
- Defined in index.ts:70