Skip to main content

Class: KeywordTable

The underlying structure of each index.

Hierarchy

Constructors

constructor

new KeywordTable(indexId?, summary?)

Parameters

NameTypeDefault value
indexId`${string}-${string}-${string}-${string}-${string}`undefined
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


summary

Optional summary: string

Inherited from

IndexStruct.summary

Defined in

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


table

table: Map<string, Set<string>>

Defined in

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


type

type: IndexStructType = IndexStructType.KEYWORD_TABLE

Defined in

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

Methods

addNode

addNode(keywords, nodeId): void

Parameters

NameType
keywordsstring[]
nodeIdstring

Returns

void

Defined in

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


deleteNode

deleteNode(keywords, nodeId): void

Parameters

NameType
keywordsstring[]
nodeIdstring

Returns

void

Defined in

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


getSummary

getSummary(): string

Returns

string

Inherited from

IndexStruct.getSummary

Defined in

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


toJson

toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Overrides

IndexStruct.toJson

Defined in

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