Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose MultiDB API for Public Preview #7356

Merged
merged 6 commits into from
Jun 16, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/hungry-zebras-laugh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@firebase/firestore": minor
---

Expose MultiDB API for Public Preview. [#7356](https://github.com/firebase/firebase-js-sdk/pull/7356)
9 changes: 9 additions & 0 deletions common/api-review/firestore-lite.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,12 +218,21 @@ export function getFirestore(): Firestore;
// @public
export function getFirestore(app: FirebaseApp): Firestore;

// @beta
export function getFirestore(databaseId: string): Firestore;

// @beta
export function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

// @public
export function increment(n: number): FieldValue;

// @public
export function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;

// @beta
export function initializeFirestore(app: FirebaseApp, settings: Settings, databaseId?: string): Firestore;

// @public
export function limit(limit: number): QueryLimitConstraint;

Expand Down
6 changes: 6 additions & 0 deletions common/api-review/firestore.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,9 +277,15 @@ export function getDocsFromServer<T>(query: Query<T>): Promise<QuerySnapshot<T>>
// @public
export function getFirestore(app: FirebaseApp): Firestore;

// @beta
export function getFirestore(databaseId: string): Firestore;

// @public
export function getFirestore(): Firestore;

// @beta
export function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

// @public
export function increment(n: number): FieldValue;

Expand Down
4 changes: 2 additions & 2 deletions packages/firestore/src/api/database.ts
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ export function getFirestore(app: FirebaseApp): Firestore;
*
* @param databaseId - The name of database.
* @returns The {@link Firestore} instance of the provided app.
* @internal
* @beta
*/
export function getFirestore(databaseId: string): Firestore;
/**
Expand All @@ -232,7 +232,7 @@ export function getFirestore(): Firestore;
* instance is associated with.
* @param databaseId - The name of database.
* @returns The {@link Firestore} instance of the provided app.
* @internal
* @beta
*/
export function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
export function getFirestore(
Expand Down
6 changes: 3 additions & 3 deletions packages/firestore/src/lite-api/database.ts
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ export function initializeFirestore(
* @param settings - A settings object to configure the `Firestore` instance.
* @param databaseId - The name of database.
* @returns A newly initialized `Firestore` instance.
* @internal
* @beta
*/
export function initializeFirestore(
app: FirebaseApp,
Expand Down Expand Up @@ -241,7 +241,7 @@ export function getFirestore(app: FirebaseApp): Firestore;
*
* @param databaseId - The name of database.
* @returns The {@link Firestore} instance of the provided app.
* @internal
* @beta
*/
export function getFirestore(databaseId: string): Firestore;
/**
Expand All @@ -253,7 +253,7 @@ export function getFirestore(databaseId: string): Firestore;
* instance is associated with.
* @param databaseId - The name of database.
* @returns The {@link Firestore} instance of the provided app.
* @internal
* @beta
*/
export function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
export function getFirestore(
Expand Down