Skip to main content

Class: SimpleIndexStore

Hierarchy

  • KVIndexStore

    SimpleIndexStore

Constructors

constructor

new SimpleIndexStore(kvStore?)

Parameters

NameType
kvStore?BaseInMemoryKVStore

Overrides

KVIndexStore.constructor

Defined in

storage/indexStore/SimpleIndexStore.ts:15

Properties

kvStore

Private kvStore: BaseInMemoryKVStore

Defined in

storage/indexStore/SimpleIndexStore.ts:13

Methods

addIndexStruct

addIndexStruct(indexStruct): Promise<void>

Parameters

NameType
indexStructIndexStruct

Returns

Promise<void>

Inherited from

KVIndexStore.addIndexStruct

Defined in

storage/indexStore/KVIndexStore.ts:17


deleteIndexStruct

deleteIndexStruct(key): Promise<void>

Parameters

NameType
keystring

Returns

Promise<void>

Inherited from

KVIndexStore.deleteIndexStruct

Defined in

storage/indexStore/KVIndexStore.ts:23


getIndexStruct

getIndexStruct(structId?): Promise<undefined | IndexStruct>

Parameters

NameType
structId?string

Returns

Promise<undefined | IndexStruct>

Inherited from

KVIndexStore.getIndexStruct

Defined in

storage/indexStore/KVIndexStore.ts:27


getIndexStructs

getIndexStructs(): Promise<IndexStruct[]>

Returns

Promise<IndexStruct[]>

Inherited from

KVIndexStore.getIndexStructs

Defined in

storage/indexStore/KVIndexStore.ts:43


persist

persist(persistPath?, fs?): Promise<void>

Parameters

NameTypeDefault value
persistPathstringDEFAULT_PERSIST_DIR
fsGenericFileSystemDEFAULT_FS

Returns

Promise<void>

Overrides

KVIndexStore.persist

Defined in

storage/indexStore/SimpleIndexStore.ts:40


toDict

toDict(): Record<string, unknown>

Returns

Record<string, unknown>

Defined in

storage/indexStore/SimpleIndexStore.ts:52


fromDict

Static fromDict(saveDict): SimpleIndexStore

Parameters

NameType
saveDictDataType

Returns

SimpleIndexStore

Defined in

storage/indexStore/SimpleIndexStore.ts:47


fromPersistDir

Static fromPersistDir(persistDir?, fs?): Promise<SimpleIndexStore>

Parameters

NameTypeDefault value
persistDirstringDEFAULT_PERSIST_DIR
fsGenericFileSystemDEFAULT_FS

Returns

Promise<SimpleIndexStore>

Defined in

storage/indexStore/SimpleIndexStore.ts:21


fromPersistPath

Static fromPersistPath(persistPath, fs?): Promise<SimpleIndexStore>

Parameters

NameTypeDefault value
persistPathstringundefined
fsGenericFileSystemDEFAULT_FS

Returns

Promise<SimpleIndexStore>

Defined in

storage/indexStore/SimpleIndexStore.ts:32