본문으로 건너뛰기

Class: IndexStruct

The underlying structure of each index.

Hierarchy

Constructors

constructor

new IndexStruct(indexId?, summary?): IndexStruct

Parameters

NameTypeDefault value
indexId`${string}-${string}-${string}-${string}-${string}`undefined
summaryundefinedundefined

Returns

IndexStruct

Defined in

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

Properties

indexId

indexId: string

Defined in

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


summary

Optional summary: string

Defined in

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

Methods

getSummary

getSummary(): string

Returns

string

Defined in

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


toJson

toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Defined in

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