Aller au contenu principal

Class: IndexList

The underlying structure of each index.

Hierarchy

Constructors

constructor

new IndexList(indexId?, summary?)

Parameters

NameTypeDefault value
indexIdstringundefined
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


nodes

nodes: string[] = []

Defined in

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


summary

Optional summary: string

Inherited from

IndexStruct.summary

Defined in

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


type

type: IndexStructType = IndexStructType.LIST

Defined in

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

Methods

addNode

addNode(node): void

Parameters

NameType
nodeBaseNode<Metadata>

Returns

void

Defined in

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


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:101