Ana içeriğe geç

Class: IndexList

The underlying structure of each index.

Hierarchy

Constructors

constructor

new IndexList(indexId?, summary?): IndexList

Parameters

NameTypeDefault value
indexId`${string}-${string}-${string}-${string}-${string}`undefined
summaryundefinedundefined

Returns

IndexList

Inherited from

IndexStruct.constructor

Defined in

packages/core/src/indices/IndexStruct.ts:10

Properties

indexId

indexId: string

Inherited from

IndexStruct.indexId

Defined in

packages/core/src/indices/IndexStruct.ts:7


nodes

nodes: string[] = []

Defined in

packages/core/src/indices/json-to-index-struct.ts:64


summary

Optional summary: string

Inherited from

IndexStruct.summary

Defined in

packages/core/src/indices/IndexStruct.ts:8


type

type: IndexStructType = IndexStructType.LIST

Defined in

packages/core/src/indices/json-to-index-struct.ts:65

Methods

addNode

addNode(node): void

Parameters

NameType
nodeBaseNode<Metadata>

Returns

void

Defined in

packages/core/src/indices/json-to-index-struct.ts:67


getSummary

getSummary(): string

Returns

string

Inherited from

IndexStruct.getSummary

Defined in

packages/core/src/indices/IndexStruct.ts:22


toJson

toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Overrides

IndexStruct.toJson

Defined in

packages/core/src/indices/json-to-index-struct.ts:71