본문으로 건너뛰기

Class: IndexDict

The underlying structure of each index.

Hierarchy

Constructors

constructor

new IndexDict(indexId?, summary?): IndexDict

Parameters

NameTypeDefault value
indexId`${string}-${string}-${string}-${string}-${string}`undefined
summaryundefinedundefined

Returns

IndexDict

Inherited from

IndexStruct.constructor

Defined in

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

Properties

indexId

indexId: string

Inherited from

IndexStruct.indexId

Defined in

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


nodesDict

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

Defined in

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


summary

Optional summary: string

Inherited from

IndexStruct.summary

Defined in

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


type

type: IndexStructType = IndexStructType.SIMPLE_DICT

Defined in

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

Methods

addNode

addNode(node, textId?): void

Parameters

NameType
nodeBaseNode<Metadata>
textId?string

Returns

void

Defined in

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


delete

delete(nodeId): void

Parameters

NameType
nodeIdstring

Returns

void

Defined in

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


getSummary

getSummary(): string

Returns

string

Overrides

IndexStruct.getSummary

Defined in

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


toJson

toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Overrides

IndexStruct.toJson

Defined in

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