Interface IndexInfo

IndexInfo represents the information about a single index including its name and field names. Array of IndexInfo objects is the result of getIndexes method and a single IndexInfo object is the result of getIndex method.

Hierarchy

  • IndexInfo

Properties

fieldTypes? fields indexName

Properties

Optional Readonly fieldTypes

fieldTypes?: (undefined | string)[]

Array of field types corresponding to the array of field names. The type in the list is only defined if the index is on a field of type JSON and is explicitly typed. If using a server that does not support this information, this property will be undefined.

Readonly fields

fields: string[]

Array of field names that define the index.

Readonly indexName

indexName: string

Index name.

Settings

Member Visibility

Theme

Generated using TypeDoc