Skip to main content

Class: IndexDict

Extends​

Constructors​

new IndexDict()​

new IndexDict(indexId?, summary?): IndexDict

Parameters​

• indexId?: `${string}-${string}-${string}-${string}-${string}`

• summary?: string

Returns​

IndexDict

Inherited from​

IndexStruct.constructor

Defined in​

packages/core/data-structs/dist/index.d.ts:45

Properties​

indexId​

indexId: string

Inherited from​

IndexStruct.indexId

Defined in​

packages/core/data-structs/dist/index.d.ts:43

nodesDict​

nodesDict: Record<string, BaseNode<Metadata>>

Defined in​

packages/core/data-structs/dist/index.d.ts:57

summary​

summary: undefined | string

Inherited from​

IndexStruct.summary

Defined in​

packages/core/data-structs/dist/index.d.ts:44

type​

type: IndexStructType

Defined in​

packages/core/data-structs/dist/index.d.ts:58

Methods​

addNode()​

addNode(node, textId?): void

Parameters​

• node: BaseNode<Metadata>

• textId?: string

Returns​

void

Defined in​

packages/core/data-structs/dist/index.d.ts:59

delete()​

delete(nodeId): void

Parameters​

• nodeId: string

Returns​

void

Defined in​

packages/core/data-structs/dist/index.d.ts:61

getSummary()​

getSummary(): string

Returns​

string

Inherited from​

IndexStruct.getSummary

Defined in​

packages/core/data-structs/dist/index.d.ts:47

toJson()​

toJson(): Record<string, unknown>

Returns​

Record<string, unknown>

Overrides​

IndexStruct.toJson

Defined in​

packages/core/data-structs/dist/index.d.ts:60