APOLLO CODE

English

简体中文

English

简体中文

Appearance

apollo-code

apollo-code / storage/src / LocalKeywordMemoryIndex

Class: LocalKeywordMemoryIndex ​

Implements ​

Constructors ​

Constructor ​

new LocalKeywordMemoryIndex(path, options?): LocalKeywordMemoryIndex

Parameters ​

path ​

string

options? ​

LocalKeywordMemoryIndexOptions = {}

Returns ​

LocalKeywordMemoryIndex

Properties ​

options ​

readonly options: LocalKeywordMemoryIndexOptions = {}

path ​

readonly path: string

Methods ​

clearDirty() ​

clearDirty(): Promise<void>

Returns ​

Promise<void>

Implementation of ​

MemoryIndexMaintenance.clearDirty

health() ​

health(records?): Promise<MemoryIndexHealth>

Parameters ​

records? ​

readonly MemoryRecord[]

Returns ​

Promise<MemoryIndexHealth>

Implementation of ​

MemoryIndexMaintenance.health

markDirty() ​

markDirty(reason): Promise<void>

Parameters ​

reason ​

string

Returns ​

Promise<void>

Implementation of ​

MemoryIndexMaintenance.markDirty

reindex() ​

reindex(records, options?): Promise<MemoryReindexReport>

Parameters ​

records ​

readonly MemoryRecord[]

options? ​

MemoryReindexOptions = {}

Returns ​

Promise<MemoryReindexReport>

Implementation of ​

MemoryIndexMaintenance.reindex

remove() ​

remove(id): Promise<void>

Parameters ​

id ​

string

Returns ​

Promise<void>

Implementation of ​

MemoryIndex.remove

search(query): Promise<readonly MemoryIndexCandidate[]>

Parameters ​

query ​

string

Returns ​

Promise<readonly MemoryIndexCandidate[]>

Implementation of ​

MemoryIndex.search

upsert() ​

upsert(record): Promise<void>

Parameters ​

record ​

MemoryRecord

Returns ​

Promise<void>

Implementation of ​

MemoryIndex.upsert