Class: IndexStruct

The underlying structure of each index.

Hierarchy

• IndexStruct

  ↳ IndexDict

  ↳ IndexList

Constructors

constructor

• new IndexStruct(indexId?, summary?)

Parameters

Name	Type	Default value
indexId	string	undefined
summary	undefined	undefined

Defined in

indices/BaseIndex.ts:19

Properties

indexId

• indexId: string

Defined in

indices/BaseIndex.ts:16

---

summary

• Optional summary: string

Defined in

indices/BaseIndex.ts:17

Methods

getSummary

▸ getSummary(): string

Returns

string

Defined in

indices/BaseIndex.ts:31

---

toJson

▸ toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Defined in

indices/BaseIndex.ts:24