From 49a1d12ff4c74087e3de6a2d50692c10d892b242 Mon Sep 17 00:00:00 2001 From: Wu-Hui Date: Thu, 4 Aug 2022 20:50:36 -0400 Subject: [PATCH] Make index beta --- packages/firestore/src/api/index_configuration.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/packages/firestore/src/api/index_configuration.ts b/packages/firestore/src/api/index_configuration.ts index 6fd53693c75..9d385a65568 100644 --- a/packages/firestore/src/api/index_configuration.ts +++ b/packages/firestore/src/api/index_configuration.ts @@ -35,8 +35,6 @@ export { EmulatorMockTokenOptions } from '../lite-api/database'; -// TODO(indexing): Remove "@internal" from the API. - /** * A single field element in an index configuration. */ @@ -64,6 +62,7 @@ export interface IndexField { /** * The SDK definition of a Firestore index. */ +/** @beta */ export interface Index { /** The ID of the collection to index. */ readonly collectionGroup: string; @@ -79,6 +78,7 @@ export interface Index { * See {@link https://firebase.google.com/docs/reference/firestore/indexes/#json_format | JSON Format} * for a description of the format of the index definition. */ +/** @beta */ export interface IndexConfiguration { /** A list of all Firestore indexes. */ readonly indexes?: Index[]; @@ -107,6 +107,7 @@ export interface IndexConfiguration { * @returns A `Promise` that resolves once all indices are successfully * configured. */ +/** @beta */ export function setIndexConfiguration( firestore: Firestore, configuration: IndexConfiguration @@ -137,6 +138,7 @@ export function setIndexConfiguration( * @returns A `Promise` that resolves once all indices are successfully * configured. */ +/** @beta */ export function setIndexConfiguration( firestore: Firestore, json: string