IndexDict

Defined in: packages/core/src/data-structs/data-structs.ts:70

Extends

• IndexStruct

Constructors

Constructor

new IndexDict(indexId, summary): IndexDict

Defined in: packages/core/src/data-structs/data-structs.ts:10

Parameters

indexId

`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}` = ...

summary

undefined | string

Returns

IndexDict

Inherited from

IndexStruct.constructor

Properties

indexId

indexId: string

Defined in: packages/core/src/data-structs/data-structs.ts:7

Inherited from

IndexStruct.indexId

---

summary

summary: undefined | string

Defined in: packages/core/src/data-structs/data-structs.ts:8

Inherited from

IndexStruct.summary

---

nodesDict

nodesDict: Record<string, BaseNode<Metadata>> = {}

Defined in: packages/core/src/data-structs/data-structs.ts:71

---

type

type: IndexStructType = IndexStructType.SIMPLE_DICT

Defined in: packages/core/src/data-structs/data-structs.ts:72

Methods

getSummary()

getSummary(): string

Defined in: packages/core/src/data-structs/data-structs.ts:25

Returns

string

Inherited from

IndexStruct.getSummary

---

addNode()

addNode(node, textId?): void

Defined in: packages/core/src/data-structs/data-structs.ts:74

Parameters

node

BaseNode

textId?

string

Returns

void

---

toJson()

toJson(): Record<string, unknown>

Defined in: packages/core/src/data-structs/data-structs.ts:79

Returns

Record<string, unknown>

Overrides

IndexStruct.toJson

---

delete()

delete(nodeId): void

Defined in: packages/core/src/data-structs/data-structs.ts:93

Parameters

nodeId

string

Returns

void