Skip to content

Commit d2235ec

Browse files
committed
Adding comments for FirebaseOptions.
1 parent 0643f4b commit d2235ec

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

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

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,16 +70,48 @@ export interface FirebaseApp {
7070
/**
7171
* @public
7272
*
73-
* Firebase configuration object
73+
* Firebase configuration object. Contains a set of parameters required by
74+
* services in order to successfully communicate with Firebase server APIs
75+
* and to associate client data with your Firebase project and
76+
* Firebase application.
7477
*/
7578
export interface FirebaseOptions {
79+
/**
80+
* An encrypted string used when calling certain APIs that don't need to
81+
* access private user data
82+
* (example value: `AIzaSyDOCAbC123dEf456GhI789jKl012-MnO`).
83+
*/
7684
apiKey?: string;
85+
/**
86+
* Auth domain for the project ID.
87+
*/
7788
authDomain?: string;
89+
/**
90+
* Default Realtime Database URL.
91+
*/
7892
databaseURL?: string;
93+
/**
94+
* The unique identifier for the project across all of Firebase and
95+
* Google Cloud.
96+
*/
7997
projectId?: string;
98+
/**
99+
* The default Cloud Storage bucket name.
100+
*/
80101
storageBucket?: string;
102+
/**
103+
* Unique numerical value used to identify each sender that can send
104+
* Firebse Cloud Messaging messages to client apps.
105+
*/
81106
messagingSenderId?: string;
107+
/**
108+
* Unique identifier for the app.
109+
*/
82110
appId?: string;
111+
/**
112+
* An ID automatically created when you enable Analytics in your
113+
* Firebase project and register a web app.
114+
*/
83115
measurementId?: string;
84116
}
85117

0 commit comments

Comments
 (0)