Class: IndexList

The underlying structure of each index.

Extends

• IndexStruct

Constructors

new IndexList()

new IndexList(indexId, summary): IndexList

Parameters

• indexId: `${string}-${string}-${string}-${string}-${string}`= undefined

• summary: undefined= undefined

Returns

IndexList

Inherited from

IndexStruct . constructor

Source

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

Properties

indexId

indexId: string

Inherited from

IndexStruct . indexId

Source

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

---

nodes

nodes: string[] = []

Source

packages/core/src/indices/json-to-index-struct.ts:64

---

summary?

optional summary: string

Inherited from

IndexStruct . summary

Source

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

---

type

type: IndexStructType = IndexStructType.LIST

Source

packages/core/src/indices/json-to-index-struct.ts:65

Methods

addNode()

addNode(node): void

Parameters

• node: BaseNode <Metadata>

Returns

void

Source

packages/core/src/indices/json-to-index-struct.ts:67

---

getSummary()

getSummary(): string

Returns

string

Inherited from

IndexStruct . getSummary

Source

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

---

toJson()

toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Overrides

IndexStruct . toJson

Source

packages/core/src/indices/json-to-index-struct.ts:71