Skip to content

Commit 06beb2c

Browse files
committed
address comments
1 parent c8ac357 commit 06beb2c

File tree

4 files changed

+18
-7
lines changed

4 files changed

+18
-7
lines changed

.changeset/config.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
"firebase-firestore-integration-test",
1515
"firebase-messaging-integration-test",
1616
"@firebase/app-exp",
17-
"@firebase/app-types-exp",
1817
"@firebase/analytics-exp",
1918
"@firebase/analytics-types-exp",
2019
"@firebase/auth-exp",

common/api-review/app-exp.api.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,13 @@ export interface FirebaseApp {
4040
readonly options: FirebaseOptions;
4141
}
4242

43-
// @public (undocumented)
43+
// @public
4444
export interface FirebaseAppConfig {
45-
// (undocumented)
4645
automaticDataCollectionEnabled?: boolean;
47-
// (undocumented)
4846
name?: string;
4947
}
5048

51-
// @public (undocumented)
49+
// @internal (undocumented)
5250
export interface _FirebaseAppInternal extends FirebaseApp {
5351
// (undocumented)
5452
checkDestroyed(): void;
@@ -58,7 +56,7 @@ export interface _FirebaseAppInternal extends FirebaseApp {
5856
isDeleted: boolean;
5957
}
6058

61-
// @public (undocumented)
59+
// @public
6260
export interface FirebaseOptions {
6361
// (undocumented)
6462
apiKey?: string;

packages-exp/app-compat/src/public-types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* @license
3-
* Copyright 2017 Google LLC
3+
* Copyright 2021 Google LLC
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");
66
* you may not use this file except in compliance with the License.

packages-exp/app-exp/src/public-types.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ export interface FirebaseApp {
6969

7070
/**
7171
* @public
72+
*
73+
* Firebase configuration object
7274
*/
7375
export interface FirebaseOptions {
7476
apiKey?: string;
@@ -83,9 +85,18 @@ export interface FirebaseOptions {
8385

8486
/**
8587
* @public
88+
*
89+
* Configuration options given to {@link (initializeApp:1) | initializeApp()}
8690
*/
8791
export interface FirebaseAppConfig {
92+
/**
93+
* custom name for the Firebase App.
94+
* The default value is `"[DEFAULT]"`.
95+
*/
8896
name?: string;
97+
/**
98+
* The settable config flag for GDPR opt-in/opt-out
99+
*/
89100
automaticDataCollectionEnabled?: boolean;
90101
}
91102

@@ -102,6 +113,9 @@ export interface _FirebaseService {
102113
_delete(): Promise<void>;
103114
}
104115

116+
/**
117+
* @internal
118+
*/
105119
export interface _FirebaseAppInternal extends FirebaseApp {
106120
container: ComponentContainer;
107121
isDeleted: boolean;

0 commit comments

Comments
 (0)