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

Fix tsdoc and update reference docs #4744

Merged
merged 4 commits into from
Apr 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion common/api-review/analytics-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ export interface EventParams {
}

// @public
export function getAnalytics(app: FirebaseApp): Analytics;
export function getAnalytics(app?: FirebaseApp): Analytics;

// @public
export function isSupported(): Promise<boolean>;
Expand Down
2 changes: 1 addition & 1 deletion common/api-review/firestore-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,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;
Expand Down
2 changes: 1 addition & 1 deletion common/api-review/firestore-lite.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,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;
Expand Down
2 changes: 1 addition & 1 deletion common/api-review/functions-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export interface FunctionsError extends FirebaseError {
export type FunctionsErrorCode = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

// @public
export function getFunctions(app: FirebaseApp, regionOrCustomDomain?: string): Functions;
export function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

// @public
export interface HttpsCallable<RequestData = unknown, ResponseData = unknown> {
Expand Down
2 changes: 1 addition & 1 deletion common/api-review/installations-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>;
Expand Down
2 changes: 1 addition & 1 deletion common/api-review/messaging-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface FirebaseMessaging {
export type _FirebaseMessagingName = 'messaging';

// @public
export function getMessaging(app: FirebaseApp): FirebaseMessaging;
export function getMessaging(app?: FirebaseApp): FirebaseMessaging;

// @public
export function getToken(messaging: FirebaseMessaging, options?: {
Expand Down
2 changes: 1 addition & 1 deletion common/api-review/performance-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion common/api-review/remote-config-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion common/api-review/storage.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export function getDownloadURL(ref: StorageReference): Promise<string>;
export function getMetadata(ref: StorageReference): Promise<FullMetadata>;

// @public
export function getStorage(app: FirebaseApp, bucketUrl?: string): StorageService;
export function getStorage(app?: FirebaseApp, bucketUrl?: string): StorageService;

// @public
export function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;
Expand Down
13 changes: 0 additions & 13 deletions docs-exp/analytics-types.analytics.app.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs-exp/analytics-types.analytics.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs-exp/analytics-types.analyticscalloptions.global.md

This file was deleted.

20 changes: 0 additions & 20 deletions docs-exp/analytics-types.analyticscalloptions.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.controlparams.event_callback.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.controlparams.event_timeout.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.controlparams.groups.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs-exp/analytics-types.controlparams.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.controlparams.send_to.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.currency.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs-exp/analytics-types.customparams.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.datalayer.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.dynamicconfig.apikey.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.dynamicconfig.appid.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.dynamicconfig.authdomain.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.dynamicconfig.databaseurl.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.dynamicconfig.locationid.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs-exp/analytics-types.dynamicconfig.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.dynamicconfig.measurementid.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.dynamicconfig.messagingsenderid.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.dynamicconfig.projectid.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/analytics-types.dynamicconfig.storagebucket.md

This file was deleted.

Loading