Interface: StorageProvider
Defined in: packages/core/src/storage/storage-provider.ts:40
Methods
addVersion()
addVersion(version): Promise<void>;Defined in: packages/core/src/storage/storage-provider.ts:45
Takes in a version of a record: it becomes current if it supersedes the current one, and is kept or dropped otherwise. Idempotent.
Parameters
| Parameter | Type |
|---|---|
version | Version |
Returns
Promise<void>
close()
close(): Promise<void>;Defined in: packages/core/src/storage/storage-provider.ts:78
Close the storage adapter.
Returns
Promise<void>
fingerprint()
fingerprint(): Promise<string>;Defined in: packages/core/src/storage/storage-provider.ts:74
One fingerprint of everything kept, hex. Equal fingerprints mean the same versions kept — for status, and for tests.
Returns
Promise<string>
getCurrent()
getCurrent(key): Promise<
| Version<unknown>
| null>;Defined in: packages/core/src/storage/storage-provider.ts:51
The current version of a record — possibly a delete.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<
| Version<unknown>
| null>
getGenesis()
getGenesis(key): Promise<
| Version<unknown>
| null>;Defined in: packages/core/src/storage/storage-provider.ts:53
The record's first version, when it has been edited and so is stored apart.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<
| Version<unknown>
| null>
getVersion()
getVersion(id): Promise<
| Version<unknown>
| null>;Defined in: packages/core/src/storage/storage-provider.ts:49
A version by its id, current or not, if this store holds it.
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<
| Version<unknown>
| null>
histories()
histories(prefix): Promise<Map<string, Version<unknown>[]>>;Defined in: packages/core/src/storage/storage-provider.ts:57
history for every record whose key starts with prefix, reading only those entries.
Parameters
| Parameter | Type |
|---|---|
prefix | string |
Returns
Promise<Map<string, Version<unknown>[]>>
history()
history(key): Promise<Version<unknown>[]>;Defined in: packages/core/src/storage/storage-provider.ts:55
Every version of a record this store keeps: current, first, and retained. Newest first.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<Version<unknown>[]>
invalidate()
invalidate(): void;Defined in: packages/core/src/storage/storage-provider.ts:76
Forgets what was read into memory: another writer changed the store underneath.
Returns
void
items()
items(collection): Promise<ItemSet>;Defined in: packages/core/src/storage/storage-provider.ts:67
The versions kept in one collection, as sync compares them: sorted, with sums.
Parameters
| Parameter | Type |
|---|---|
collection | string |
Returns
Promise<ItemSet>
keptVersions()
keptVersions(collection): Promise<Version<unknown>[]>;Defined in: packages/core/src/storage/storage-provider.ts:65
Every version kept in one collection, current or not, superseded ones as their stubs.
Parameters
| Parameter | Type |
|---|---|
collection | string |
Returns
Promise<Version<unknown>[]>
listCurrent()
listCurrent(): Promise<Version<unknown>[]>;Defined in: packages/core/src/storage/storage-provider.ts:59
Current versions of every record, deletes included.
Returns
Promise<Version<unknown>[]>
queryVersions()
queryVersions(collection): Promise<Version<unknown>[]>;Defined in: packages/core/src/storage/storage-provider.ts:61
Current versions in one collection, deletes included — found through the store's collection index.
Parameters
| Parameter | Type |
|---|---|
collection | string |
Returns
Promise<Version<unknown>[]>
removeVersion()
removeVersion(id): Promise<void>;Defined in: packages/core/src/storage/storage-provider.ts:47
Drops a version from the store and wherever it is indexed.
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<void>
sums()
sums(): Promise<ReadonlyMap<string, Sum>>;Defined in: packages/core/src/storage/storage-provider.ts:69
Every collection this store keeps anything in, and the sum of its version ids.
Returns
Promise<ReadonlyMap<string, Sum>>
versionIds()
versionIds(): Promise<string[]>;Defined in: packages/core/src/storage/storage-provider.ts:63
The id of every version this store keeps — current, first and retained.
Returns
Promise<string[]>