Class: KeywordTable

The underlying structure of each index.

Hierarchy

• IndexStruct

  ↳ KeywordTable

Constructors

constructor

• new KeywordTable(indexId?, summary?): KeywordTable

Parameters

Name	Type	Default value
indexId	`${string}-${string}-${string}-${string}-${string}`	undefined
summary	undefined	undefined

Returns

KeywordTable

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

---

summary

• Optional summary: string

Inherited from

IndexStruct.summary

Defined in

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

---

table

• table: Map<string, Set<string>>

Defined in

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

---

type

• type: IndexStructType = IndexStructType.KEYWORD_TABLE

Defined in

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

Methods

addNode

▸ addNode(keywords, nodeId): void

Parameters

Name	Type
keywords	string[]
nodeId	string

Returns

void

Defined in

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

---

deleteNode

▸ deleteNode(keywords, nodeId): void

Parameters

Name	Type
keywords	string[]
nodeId	string

Returns

void

Defined in

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

---

getSummary

▸ getSummary(): string

Returns

string

Inherited from

IndexStruct.getSummary

Defined in

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

---

toJson

▸ toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Overrides

IndexStruct.toJson

Defined in

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