Class: IndexStruct
The underlying structure of each index.
Hierarchy
IndexStruct
Constructors
constructor
• new IndexStruct(indexId?, summary?)
Parameters
| Name | Type | Default value |
|---|---|---|
indexId | `${string}-${string}-${string}-${string}-${string}` | undefined |
summary | undefined | undefined |
Defined in
packages/core/src/indices/BaseIndex.ts:19
Properties
indexId
• indexId: string
Defined in
packages/core/src/indices/BaseIndex.ts:16
summary
• Optional summary: string
Defined in
packages/core/src/indices/BaseIndex.ts:17
Methods
getSummary
▸ getSummary(): string
Returns
string
Defined in
packages/core/src/indices/BaseIndex.ts:31
toJson
▸ toJson(): Record<string, unknown>
Returns
Record<string, unknown>