Class: IndexDict
The underlying structure of each index.
Hierarchy
↳
IndexDict
Constructors
constructor
• new IndexDict(indexId?, summary?)
Parameters
| Name | Type | Default value |
|---|---|---|
indexId | `${string}-${string}-${string}-${string}-${string}` | undefined |
summary | undefined | undefined |
Inherited from
Defined in
packages/core/src/indices/BaseIndex.ts:19
Properties
indexId
• indexId: string
Inherited from
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
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
| Name | Type |
|---|---|
node | BaseNode<Metadata> |
textId? | string |
Returns
void
Defined in
packages/core/src/indices/BaseIndex.ts:56
delete
▸ delete(nodeId): void
Parameters
| Name | Type |
|---|---|
nodeId | string |
Returns
void
Defined in
packages/core/src/indices/BaseIndex.ts:69
getSummary
▸ getSummary(): string
Returns
string
Overrides
Defined in
packages/core/src/indices/BaseIndex.ts:49
toJson
▸ toJson(): Record<string, unknown>
Returns
Record<string, unknown>