Class: IndexList
The underlying structure of each index.
Hierarchy
-
↳
IndexList
Constructors
constructor
• new IndexList(indexId?
, summary?
): IndexList
Parameters
Name | Type | Default value |
---|---|---|
indexId | `${string}-${string}-${string}-${string}-${string}` | undefined |
summary | undefined | undefined |
Returns
Inherited from
Defined in
packages/core/src/indices/IndexStruct.ts:10
Properties
indexId
• indexId: string
Inherited from
Defined in
packages/core/src/indices/IndexStruct.ts:7
nodes
• nodes: string
[] = []
Defined in
packages/core/src/indices/json-to-index-struct.ts:64
summary
• Optional
summary: string
Inherited from
Defined in
packages/core/src/indices/IndexStruct.ts:8
type
• type: IndexStructType
= IndexStructType.LIST
Defined in
packages/core/src/indices/json-to-index-struct.ts:65
Methods
addNode
▸ addNode(node
): void
Parameters
Name | Type |
---|---|
node | BaseNode <Metadata > |
Returns
void
Defined in
packages/core/src/indices/json-to-index-struct.ts:67
getSummary
▸ getSummary(): string
Returns
string
Inherited from
Defined in
packages/core/src/indices/IndexStruct.ts:22
toJson
▸ toJson(): Record
<string
, unknown
>
Returns
Record
<string
, unknown
>