Class: abstract IndexStruct

The underlying structure of each index.

Extended by

• KeywordTable
• IndexDict
• IndexList

Constructors

new IndexStruct()

new IndexStruct(indexId, summary): IndexStruct

Parameters

• indexId: `${string}-${string}-${string}-${string}-${string}`= undefined

• summary: undefined= undefined

Returns

IndexStruct

Source

packages/core/src/indices/IndexStruct.ts:10

Properties

indexId

indexId: string

Source

packages/core/src/indices/IndexStruct.ts:7

---

summary?

optional summary: string

Source

packages/core/src/indices/IndexStruct.ts:8

Methods

getSummary()

getSummary(): string

Returns

string

Source

packages/core/src/indices/IndexStruct.ts:22

---

toJson()

toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Source

packages/core/src/indices/IndexStruct.ts:15