Fix tsdoc and update reference docs (#4744)

* fix tsdoc * fix tsdoc in rc * update reference docs
firebase · Apr 9, 2021 · 626c05b · 626c05b
1 parent 67b4f62
commit 626c05b
Show file tree

Hide file tree

Showing 477 changed files with 116 additions and 7,555 deletions.
diff --git a/common/api-review/firestore-exp.api.md b/common/api-review/firestore-exp.api.md
@@ -200,7 +200,7 @@ export function getDocsFromCache<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 export function getDocsFromServer<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 
 // @public
-export function getFirestore(app: FirebaseApp): FirebaseFirestore;
+export function getFirestore(app?: FirebaseApp): FirebaseFirestore;
 
 // @public
 export function increment(n: number): FieldValue;

diff --git a/common/api-review/firestore-lite.api.md b/common/api-review/firestore-lite.api.md
@@ -158,7 +158,7 @@ export function getDoc<T>(reference: DocumentReference<T>): Promise<DocumentSnap
 export function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 
 // @public
-export function getFirestore(app: FirebaseApp): FirebaseFirestore;
+export function getFirestore(app?: FirebaseApp): FirebaseFirestore;
 
 // @public
 export function increment(n: number): FieldValue;

diff --git a/common/api-review/installations-exp.api.md b/common/api-review/installations-exp.api.md
@@ -23,7 +23,7 @@ export interface _FirebaseInstallationsInternal {
 export function getId(installations: FirebaseInstallations): Promise<string>;
 
 // @public
-export function getInstallations(app: FirebaseApp): FirebaseInstallations;
+export function getInstallations(app?: FirebaseApp): FirebaseInstallations;
 
 // @public
 export function getToken(installations: FirebaseInstallations, forceRefresh?: boolean): Promise<string>;

diff --git a/common/api-review/performance-exp.api.md b/common/api-review/performance-exp.api.md
@@ -13,7 +13,7 @@ export interface FirebasePerformance {
 }
 
 // @public
-export function getPerformance(app: FirebaseApp): FirebasePerformance;
+export function getPerformance(app?: FirebaseApp): FirebasePerformance;
 
 // @public
 export function initializePerformance(app: FirebaseApp, settings?: PerformanceSettings): FirebasePerformance;

diff --git a/common/api-review/remote-config-exp.api.md b/common/api-review/remote-config-exp.api.md
@@ -31,7 +31,7 @@ export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
 export function getNumber(remoteConfig: RemoteConfig, key: string): number;
 
 // @public (undocumented)
-export function getRemoteConfig(app: FirebaseApp): RemoteConfig;
+export function getRemoteConfig(app?: FirebaseApp): RemoteConfig;
 
 // @public
 export function getString(remoteConfig: RemoteConfig, key: string): string;

diff --git a/docs-exp/analytics-types.analytics.app.md b/docs-exp/analytics-types.analytics.app.md
diff --git a/docs-exp/analytics-types.analytics.md b/docs-exp/analytics-types.analytics.md
diff --git a/docs-exp/analytics-types.analyticscalloptions.global.md b/docs-exp/analytics-types.analyticscalloptions.global.md
diff --git a/docs-exp/analytics-types.analyticscalloptions.md b/docs-exp/analytics-types.analyticscalloptions.md
diff --git a/docs-exp/analytics-types.controlparams.event_callback.md b/docs-exp/analytics-types.controlparams.event_callback.md
diff --git a/docs-exp/analytics-types.controlparams.event_timeout.md b/docs-exp/analytics-types.controlparams.event_timeout.md
diff --git a/docs-exp/analytics-types.controlparams.groups.md b/docs-exp/analytics-types.controlparams.groups.md
diff --git a/docs-exp/analytics-types.controlparams.md b/docs-exp/analytics-types.controlparams.md
diff --git a/docs-exp/analytics-types.controlparams.send_to.md b/docs-exp/analytics-types.controlparams.send_to.md
diff --git a/docs-exp/analytics-types.currency.md b/docs-exp/analytics-types.currency.md
diff --git a/docs-exp/analytics-types.customparams.md b/docs-exp/analytics-types.customparams.md
diff --git a/docs-exp/analytics-types.datalayer.md b/docs-exp/analytics-types.datalayer.md
diff --git a/docs-exp/analytics-types.dynamicconfig.apikey.md b/docs-exp/analytics-types.dynamicconfig.apikey.md
diff --git a/docs-exp/analytics-types.dynamicconfig.appid.md b/docs-exp/analytics-types.dynamicconfig.appid.md
diff --git a/docs-exp/analytics-types.dynamicconfig.authdomain.md b/docs-exp/analytics-types.dynamicconfig.authdomain.md
diff --git a/docs-exp/analytics-types.dynamicconfig.databaseurl.md b/docs-exp/analytics-types.dynamicconfig.databaseurl.md
diff --git a/docs-exp/analytics-types.dynamicconfig.locationid.md b/docs-exp/analytics-types.dynamicconfig.locationid.md
diff --git a/docs-exp/analytics-types.dynamicconfig.md b/docs-exp/analytics-types.dynamicconfig.md
diff --git a/docs-exp/analytics-types.dynamicconfig.measurementid.md b/docs-exp/analytics-types.dynamicconfig.measurementid.md
diff --git a/docs-exp/analytics-types.dynamicconfig.messagingsenderid.md b/docs-exp/analytics-types.dynamicconfig.messagingsenderid.md
diff --git a/docs-exp/analytics-types.dynamicconfig.projectid.md b/docs-exp/analytics-types.dynamicconfig.projectid.md
diff --git a/docs-exp/analytics-types.dynamicconfig.storagebucket.md b/docs-exp/analytics-types.dynamicconfig.storagebucket.md