Skip to content

Commit ca809e0

Browse files
committed
Clarify text
1 parent 978ea91 commit ca809e0

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

packages/firestore/src/api/database.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -195,43 +195,43 @@ export function initializeFirestore(
195195
});
196196
}
197197

198+
/**
199+
* Returns the existing default {@link Firestore} instance that is associated with the
200+
* default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
201+
* instance with default settings.
202+
*
203+
* @returns The default {@link Firestore} instance of the default app.
204+
*/
205+
export function getFirestore(): Firestore;
198206
/**
199207
* Returns the existing default {@link Firestore} instance that is associated with the
200208
* provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
201209
* instance with default settings.
202210
*
203211
* @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
204212
* instance is associated with.
205-
* @returns The {@link Firestore} instance of the provided app.
213+
* @returns The default {@link Firestore} instance of the provided app.
206214
*/
207215
export function getFirestore(app: FirebaseApp): Firestore;
208216
/**
209-
* Returns the existing {@link Firestore} instance that is associated with the
217+
* Returns the existing named {@link Firestore} instance that is associated with the
210218
* default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
211219
* instance with default settings.
212220
*
213221
* @param databaseId - The name of the database.
214-
* @returns The {@link Firestore} instance of the provided app.
222+
* @returns The named {@link Firestore} instance of the default app.
215223
* @beta
216224
*/
217225
export function getFirestore(databaseId: string): Firestore;
218226
/**
219-
* Returns the existing default {@link Firestore} instance that is associated with the
220-
* default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
221-
* instance with default settings.
222-
*
223-
* @returns The {@link Firestore} instance of the provided app.
224-
*/
225-
export function getFirestore(): Firestore;
226-
/**
227-
* Returns the existing {@link Firestore} instance that is associated with the
227+
* Returns the existing named {@link Firestore} instance that is associated with the
228228
* provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
229229
* instance with default settings.
230230
*
231231
* @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
232232
* instance is associated with.
233233
* @param databaseId - The name of the database.
234-
* @returns The {@link Firestore} instance of the provided app.
234+
* @returns The named {@link Firestore} instance of the provided app.
235235
* @beta
236236
*/
237237
export function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

0 commit comments

Comments
 (0)