Class: IndexDict
The underlying structure of each index.
Hierarchy
↳
IndexDict
Constructors
constructor
• new IndexDict(indexId?
, summary?
)
Parameters
Name | Type | Default value |
---|---|---|
indexId | string | undefined |
summary | undefined | undefined |
Inherited from
Defined in
indices/BaseIndex.ts:19
Properties
docStore
• docStore: Record
<string
, Document
> = {}
Defined in
indices/BaseIndex.ts:46
indexId
• indexId: string
Inherited from
Defined in
indices/BaseIndex.ts:16
nodesDict
• nodesDict: Record
<string
, BaseNode
> = {}
Defined in
indices/BaseIndex.ts:45
summary
• Optional
summary: string
Inherited from
Defined in
indices/BaseIndex.ts:17
type
• type: IndexStructType
= IndexStructType.SIMPLE_DICT
Defined in
indices/BaseIndex.ts:47
Methods
addNode
▸ addNode(node
, textId?
): void
Parameters
Name | Type |
---|---|
node | BaseNode |
textId? | string |
Returns
void
Defined in
indices/BaseIndex.ts:56
getSummary
▸ getSummary(): string
Returns
string
Overrides
Defined in
indices/BaseIndex.ts:49
toJson
▸ toJson(): Record
<string
, unknown
>
Returns
Record
<string
, unknown
>
Overrides
Defined in
indices/BaseIndex.ts:61