Class: IndexList
The underlying structure of each index.
Hierarchy
↳
IndexList
Constructors
constructor
• new IndexList(indexId?, summary?)
Parameters
| Name | Type | Default value |
|---|---|---|
indexId | `${string}-${string}-${string}-${string}-${string}` | undefined |
summary | undefined | undefined |
Inherited from
Defined in
packages/core/src/indices/BaseIndex.ts:19
Properties
indexId
• indexId: string
Inherited from
Defined in
packages/core/src/indices/BaseIndex.ts:16
nodes
• nodes: string[] = []
Defined in
packages/core/src/indices/BaseIndex.ts:94
summary
• Optional summary: string
Inherited from
Defined in
packages/core/src/indices/BaseIndex.ts:17
type
• type: IndexStructType = IndexStructType.LIST
Defined in
packages/core/src/indices/BaseIndex.ts:95
Methods
addNode
▸ addNode(node): void
Parameters
| Name | Type |
|---|---|
node | BaseNode<Metadata> |
Returns
void
Defined in
packages/core/src/indices/BaseIndex.ts:97
getSummary
▸ getSummary(): string
Returns
string
Inherited from
Defined in
packages/core/src/indices/BaseIndex.ts:31
toJson
▸ toJson(): Record<string, unknown>
Returns
Record<string, unknown>