Interface Store<V>

Store is a key-value store interface

Interface

Store

Type Parameters

V

Hierarchy

Store

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}

Memberof
Store

Returns Promise<void>
- Defined in src/lib/store/store.ts:91

clearPrepareOperationCache

clearPrepareOperationCache(): void
Clear all prepare operation cache.

Memberof
Store

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

commit

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

Returns
{Promise}

Memberof
Store

Returns Promise<void>
- Defined in src/lib/store/store.ts:78

getNodes

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

Returns
{Promise<Field[]>}

Memberof
Store
Parameters
- key: Field
Returns Promise<Field[]>
- 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}

Memberof
Store

Returns Promise<Field>
- Defined in src/lib/store/store.ts:64

getValue

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

Returns
{Promise}

Memberof
Store
Parameters
- key: Field
Returns Promise<V>
- 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>>}

Memberof
Store

Returns Promise<Map<string, V>>
- Defined in src/lib/store/store.ts:98

prepareDelNodes

prepareDelNodes(key: Field): void
Prepare delete nodes for a key. Use the commit() method to actually submit changes.

Memberof
Store
Parameters
- key: Field
Returns void
- Defined in src/lib/store/store.ts:34

prepareDelValue

prepareDelValue(path: Field): void
Prepare delete the value for a key. Use the commit() method to actually submit changes.

Memberof
Store
Parameters
- path: Field
Returns void
- Defined in src/lib/store/store.ts:57

preparePutNodes

preparePutNodes(key: Field, value: Field[]): void
Prepare put nodes for a key. Use the commit() method to actually submit changes.

Memberof
Store
Parameters
- key: Field
- value: Field[]
Returns void
- Defined in src/lib/store/store.ts:27

preparePutValue

preparePutValue(path: Field, value: V): void
Prepare put the value for a key. Use the commit() method to actually submit changes.

Memberof
Store
Parameters
- path: Field
- value: V
Returns void
- Defined in src/lib/store/store.ts:50

prepareUpdateRoot

prepareUpdateRoot(root: Field): void
Prepare update the root. Use the commit() method to actually submit changes.

Memberof
Store
Parameters
- root: Field
Returns void
- Defined in src/lib/store/store.ts:71

Generated using TypeDoc