Type alias ListIndexesOptions

ListIndexesOptions: {
    withHidden?: boolean;
    withStats?: boolean;
}

Options for listing indexes.

Type declaration

  • Optional withHidden?: boolean

    If set to true, includes internal indexes as well as indexes that are not yet fully built but are in the building phase.

    You should cast the resulting indexes to HiddenIndex to ensure internal and incomplete indexes are accurately represented.

    Default: false.

  • Optional withStats?: boolean

    If set to true, includes additional information about each index.

    Default: false

Settings

Theme