Querylight TS Demo

FieldIndex

Common interface implemented by all field indexes.

Back to docs search

Reference Entry

FieldIndex

API Reference · foundation · order 115

Common interface implemented by all field indexes.

Relevant APIs

FieldIndex IndexState

Tags

api-reference interfaces

FieldIndex

Common interface implemented by all field indexes.

Declaration

interface FieldIndex

Members

indexState

```ts indexState: IndexState ```

loadState

```ts loadState(fieldIndexState: IndexState): FieldIndex ``` Parameters: - `fieldIndexState: IndexState`

indexValue

```ts indexValue(documentId: string, value: string): void ``` Parameters: - `documentId: string` - `value: string`