@@ -35,8 +35,6 @@ export {
35
35
EmulatorMockTokenOptions
36
36
} from '../lite-api/database' ;
37
37
38
- // TODO(indexing): Remove "@internal" from the API.
39
-
40
38
/**
41
39
* A single field element in an index configuration.
42
40
*/
@@ -64,6 +62,7 @@ export interface IndexField {
64
62
/**
65
63
* The SDK definition of a Firestore index.
66
64
*/
65
+ /** @beta */
67
66
export interface Index {
68
67
/** The ID of the collection to index. */
69
68
readonly collectionGroup : string ;
@@ -79,6 +78,7 @@ export interface Index {
79
78
* See {@link https://firebase.google.com/docs/reference/firestore/indexes/#json_format | JSON Format}
80
79
* for a description of the format of the index definition.
81
80
*/
81
+ /** @beta */
82
82
export interface IndexConfiguration {
83
83
/** A list of all Firestore indexes. */
84
84
readonly indexes ?: Index [ ] ;
@@ -107,6 +107,7 @@ export interface IndexConfiguration {
107
107
* @returns A `Promise` that resolves once all indices are successfully
108
108
* configured.
109
109
*/
110
+ /** @beta */
110
111
export function setIndexConfiguration (
111
112
firestore : Firestore ,
112
113
configuration : IndexConfiguration
@@ -137,6 +138,7 @@ export function setIndexConfiguration(
137
138
* @returns A `Promise` that resolves once all indices are successfully
138
139
* configured.
139
140
*/
141
+ /** @beta */
140
142
export function setIndexConfiguration (
141
143
firestore : Firestore ,
142
144
json : string
0 commit comments