Aller au contenu principal

Class: IndexDict

The underlying structure of each index.

Hierarchy

Constructors

constructor

new IndexDict(indexId?, summary?)

Parameters

NameTypeDefault value
indexIdstringundefined
summaryundefinedundefined

Inherited from

IndexStruct.constructor

Defined in

packages/core/src/indices/BaseIndex.ts:19

Properties

indexId

indexId: string

Inherited from

IndexStruct.indexId

Defined in

packages/core/src/indices/BaseIndex.ts:16


nodesDict

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

Defined in

packages/core/src/indices/BaseIndex.ts:46


summary

Optional summary: string

Inherited from

IndexStruct.summary

Defined in

packages/core/src/indices/BaseIndex.ts:17


type

type: IndexStructType = IndexStructType.SIMPLE_DICT

Defined in

packages/core/src/indices/BaseIndex.ts:47

Methods

addNode

addNode(node, textId?): void

Parameters

NameType
nodeBaseNode<Metadata>
textId?string

Returns

void

Defined in

packages/core/src/indices/BaseIndex.ts:56


delete

delete(nodeId): void

Parameters

NameType
nodeIdstring

Returns

void

Defined in

packages/core/src/indices/BaseIndex.ts:69


getSummary

getSummary(): string

Returns

string

Overrides

IndexStruct.getSummary

Defined in

packages/core/src/indices/BaseIndex.ts:49


toJson

toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Overrides

IndexStruct.toJson

Defined in

packages/core/src/indices/BaseIndex.ts:61