Class: IndexStruct

The underlying structure of each index.

Hierarchy

• IndexStruct

  ↳ IndexDict

  ↳ IndexList

  ↳ KeywordTable

Constructors

constructor

• new IndexStruct(indexId?, summary?): IndexStruct

Parameters

Name	Type	Default value
indexId	`${string}-${string}-${string}-${string}-${string}`	undefined
summary	undefined	undefined

Returns

IndexStruct

Defined in

packages/core/src/indices/BaseIndex.ts:20

Properties

indexId

• indexId: string

Defined in

packages/core/src/indices/BaseIndex.ts:17

---

summary

• Optional summary: string

Defined in

packages/core/src/indices/BaseIndex.ts:18

Methods

getSummary

▸ getSummary(): string

Returns

string

Defined in

packages/core/src/indices/BaseIndex.ts:32

---

toJson

▸ toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Defined in

packages/core/src/indices/BaseIndex.ts:25