Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

IndexConfiguration interface

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Warning: This API is now obsolete.

Instead of creating cache indexes manually, consider using enablePersistentCacheIndexAutoCreation() to let the SDK decide whether to create cache indexes for queries running locally.

A list of Firestore indexes to speed up local query execution.

See JSON Format for a description of the format of the index definition.

<b>Signature:</b>

export declare interface IndexConfiguration 

Properties

IndexConfiguration.indexes

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

A list of all Firestore indexes.

<b>Signature:</b>

readonly indexes?: Index[];