Files
LlamaIndexTS/apps/docs/docs/api/classes/IndexStruct.md
T
Yi Ding 7699f5432d set typedoc revision to main
In theory this will stop the API docs thrashing on every build.

Of course, there is a drawback in that if main changes but we haven't
released a new version of the docs yet the links will go out of date.

So longer term we might want to investigate some kind of variable where
we can continue to have up to date revs but keep the rev in a single
variable somewhere:

https://github.com/facebook/docusaurus/issues/395

In the meantime much smaller commits will be a relief
2023-07-25 23:06:44 -07:00

1.5 KiB

id, title, sidebar_label, sidebar_position, custom_edit_url
id title sidebar_label sidebar_position custom_edit_url
IndexStruct Class: IndexStruct IndexStruct 0 null

The underlying structure of each index.

Hierarchy

Constructors

constructor

new IndexStruct(indexId?, summary?)

Parameters

Name Type Default value
indexId string undefined
summary undefined undefined

Defined in

indices/BaseIndex.ts:19

Properties

indexId

indexId: string

Defined in

indices/BaseIndex.ts:16


summary

Optional summary: string

Defined in

indices/BaseIndex.ts:17

Methods

getSummary

getSummary(): string

Returns

string

Defined in

indices/BaseIndex.ts:31


toJson

toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Defined in

indices/BaseIndex.ts:24