Interface Store<V>

Store is a key-value store interface

Store

interface Store<V> {
    clear(): Promise<void>;
    clearPrepareOperationCache(): void;
    commit(): Promise<void>;
    getNodes(key): Promise<Field[]>;
    getRoot(): Promise<Field>;
    getValue(key): Promise<V>;
    getValuesMap?(): Promise<Map<string, V>>;
    prepareDelNodes(key): void;
    prepareDelValue(path): void;
    preparePutNodes(key, value): void;
    preparePutValue(path, value): void;
    prepareUpdateRoot(root): void;
}

Type Parameters

V

Implemented by

Index

Methods

clear clearPrepareOperationCache commit getNodes getRoot getValue getValuesMap? prepareDelNodes prepareDelValue preparePutNodes preparePutValue prepareUpdateRoot

Methods

clear

clear(): Promise<void>
Clear the store.

Returns Promise<void>
{Promise}

Memberof
Store
- Defined in src/lib/store/store.ts:91

clearPrepareOperationCache

clearPrepareOperationCache(): void
Clear all prepare operation cache.

Returns void
Memberof
Store
- Defined in src/lib/store/store.ts:84

commit

commit(): Promise<void>
Use the commit() method to actually submit all prepare changes.

Returns Promise<void>
{Promise}

Memberof
Store
- Defined in src/lib/store/store.ts:78

getNodes

getNodes(key): Promise<Field[]>
Get nodes for a key. Error is thrown when a key that does not exist is being accessed.
Parameters
- key: Field
Returns Promise<Field[]>
{Promise<Field[]>}

Memberof
Store
- Defined in src/lib/store/store.ts:19

getRoot

getRoot(): Promise<Field>
Get the tree root. Error is thrown when the root does not exist.

Returns Promise<Field>
{Promise}

Memberof
Store
- Defined in src/lib/store/store.ts:64

getValue

getValue(key): Promise<V>
Get the value for a key. Error is thrown when a key that does not exist is being accessed.
Parameters
- key: Field
Returns Promise<V>
{Promise}

Memberof
Store
- Defined in src/lib/store/store.ts:42

`Optional` getValuesMap

getValuesMap(): Promise<Map<string, V>>
Get values map, key is Field.toString().

Returns Promise<Map<string, V>>
{Promise<Map<string, V>>}

Memberof
Store
- Defined in src/lib/store/store.ts:98

prepareDelNodes

prepareDelNodes(key): void
Prepare delete nodes for a key. Use the commit() method to actually submit changes.
Parameters
- key: Field
Returns void
Memberof
Store
- Defined in src/lib/store/store.ts:34

prepareDelValue

prepareDelValue(path): void
Prepare delete the value for a key. Use the commit() method to actually submit changes.
Parameters
- path: Field
Returns void
Memberof
Store
- Defined in src/lib/store/store.ts:57

preparePutNodes

preparePutNodes(key, value): void
Prepare put nodes for a key. Use the commit() method to actually submit changes.
Parameters
- key: Field
- value: Field[]
Returns void
Memberof
Store
- Defined in src/lib/store/store.ts:27

preparePutValue

preparePutValue(path, value): void
Prepare put the value for a key. Use the commit() method to actually submit changes.
Parameters
- path: Field
- value: V
Returns void
Memberof
Store
- Defined in src/lib/store/store.ts:50

prepareUpdateRoot

prepareUpdateRoot(root): void
Prepare update the root. Use the commit() method to actually submit changes.
Parameters
- root: Field
Returns void
Memberof
Store
- Defined in src/lib/store/store.ts:71