Skip to content

Commit 4ff465a

Browse files
committed
parameter consistency. logging cleanup.
1 parent ed091d2 commit 4ff465a

File tree

3 files changed

+19
-38
lines changed

3 files changed

+19
-38
lines changed

common/api-review/app.api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,10 @@ export function initializeApp(options: FirebaseOptions, config?: FirebaseAppSett
110110
export function initializeApp(): FirebaseApp;
111111

112112
// @public
113-
export function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
113+
export function initializeServerApp(options: FirebaseOptions | FirebaseApp, config?: FirebaseServerAppSettings): FirebaseServerApp;
114114

115115
// @public
116-
export function initializeServerApp(_serverAppConfig?: FirebaseServerAppSettings): FirebaseServerApp;
116+
export function initializeServerApp(config?: FirebaseServerAppSettings): FirebaseServerApp;
117117

118118
// @public
119119
export function initializeServerApp(): FirebaseServerApp;

docs-devsite/app.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ This package coordinates the communication between the different Firebase compon
2323
| <b>function()</b> |
2424
| [getApps()](./app.md#getapps) | A (read-only) array of all initialized apps. |
2525
| [initializeApp()](./app.md#initializeapp) | Creates and initializes a FirebaseApp instance. |
26-
| [initializeServerApp()](./app.md#initializeserverapp) | Creates and initializes a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) instance using Auto Init. |
27-
| <b>function(\_serverAppConfig, ...)</b> |
28-
| [initializeServerApp(\_serverAppConfig)](./app.md#initializeserverapp_b13f0eb) | Creates and initializes a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) instance. |
26+
| [initializeServerApp()](./app.md#initializeserverapp) | Creates and initializes a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) instance using Firebase App Hosting Auto Init. |
27+
| <b>function(config, ...)</b> |
28+
| [initializeServerApp(config)](./app.md#initializeserverapp_e7d0728) | Creates and initializes a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) instance. |
2929
| <b>function(libraryKeyOrName, ...)</b> |
3030
| [registerVersion(libraryKeyOrName, version, variant)](./app.md#registerversion_f673248) | Registers a library's name and version for platform logging purposes. |
3131
| <b>function(logCallback, ...)</b> |
@@ -121,7 +121,7 @@ export declare function initializeApp(): FirebaseApp;
121121

122122
### initializeServerApp() {:#initializeserverapp}
123123

124-
Creates and initializes a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) instance using Auto Init.
124+
Creates and initializes a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) instance using Firebase App Hosting Auto Init.
125125

126126
<b>Signature:</b>
127127

@@ -134,29 +134,29 @@ export declare function initializeServerApp(): FirebaseServerApp;
134134

135135
The initialized \`<!-- -->FirebaseServerApp.
136136

137-
## function(\_serverAppConfig, ...)
137+
## function(config, ...)
138138

139-
### initializeServerApp(\_serverAppConfig) {:#initializeserverapp_b13f0eb}
139+
### initializeServerApp(config) {:#initializeserverapp_e7d0728}
140140

141141
Creates and initializes a [FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface) instance.
142142

143143
<b>Signature:</b>
144144

145145
```typescript
146-
export declare function initializeServerApp(_serverAppConfig?: FirebaseServerAppSettings): FirebaseServerApp;
146+
export declare function initializeServerApp(config?: FirebaseServerAppSettings): FirebaseServerApp;
147147
```
148148

149149
#### Parameters
150150

151151
| Parameter | Type | Description |
152152
| --- | --- | --- |
153-
| \_serverAppConfig | [FirebaseServerAppSettings](./app.firebaseserverappsettings.md#firebaseserverappsettings_interface) | |
153+
| config | [FirebaseServerAppSettings](./app.firebaseserverappsettings.md#firebaseserverappsettings_interface) | Optional <code>FirebaseServerApp</code> configuration. |
154154

155155
<b>Returns:</b>
156156

157157
[FirebaseServerApp](./app.firebaseserverapp.md#firebaseserverapp_interface)
158158

159-
The initialized `FirebaseServerApp` with default app configuration.
159+
The initialized `FirebaseServerApp`<!-- -->.
160160

161161
## function(libraryKeyOrName, ...)
162162

@@ -365,15 +365,15 @@ See [Add Firebase to your app](https://firebase.google.com/docs/web/setup#add_fi
365365
<b>Signature:</b>
366366

367367
```typescript
368-
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
368+
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config?: FirebaseServerAppSettings): FirebaseServerApp;
369369
```
370370

371371
#### Parameters
372372

373373
| Parameter | Type | Description |
374374
| --- | --- | --- |
375375
| options | [FirebaseOptions](./app.firebaseoptions.md#firebaseoptions_interface) \| [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | <code>Firebase.AppOptions</code> to configure the app's services, or a a <code>FirebaseApp</code> instance which contains the <code>AppOptions</code> within. |
376-
| config | [FirebaseServerAppSettings](./app.firebaseserverappsettings.md#firebaseserverappsettings_interface) | <code>FirebaseServerApp</code> configuration. |
376+
| config | [FirebaseServerAppSettings](./app.firebaseserverappsettings.md#firebaseserverappsettings_interface) | Optional <code>FirebaseServerApp</code> configuration. |
377377

378378
<b>Returns:</b>
379379

packages/app/src/api.ts

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -221,32 +221,33 @@ export function initializeApp(
221221
*
222222
* @param options - `Firebase.AppOptions` to configure the app's services, or a
223223
* a `FirebaseApp` instance which contains the `AppOptions` within.
224-
* @param config - `FirebaseServerApp` configuration.
224+
* @param config - Optional `FirebaseServerApp` configuration.
225225
*
226226
* @returns The initialized `FirebaseServerApp`.
227227
*
228228
* @public
229229
*/
230230
export function initializeServerApp(
231231
options: FirebaseOptions | FirebaseApp,
232-
config: FirebaseServerAppSettings
232+
config?: FirebaseServerAppSettings
233233
): FirebaseServerApp;
234234

235235
/**
236236
* Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
237237
*
238238
* @param config - Optional `FirebaseServerApp` configuration.
239239
*
240-
* @returns The initialized `FirebaseServerApp` with default app configuration.
240+
* @returns The initialized `FirebaseServerApp`.
241241
*
242242
* @public
243243
*/
244244
export function initializeServerApp(
245-
_serverAppConfig?: FirebaseServerAppSettings
245+
config?: FirebaseServerAppSettings
246246
): FirebaseServerApp;
247247

248248
/**
249-
* Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance using Auto Init.
249+
* Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance using
250+
* Firebase App Hosting Auto Init.
250251
*
251252
* @returns The initialized `FirebaseServerApp.
252253
*
@@ -264,30 +265,15 @@ export function initializeServerApp(
264265

265266
let app: FirebaseApp;
266267
let firebaseOptions: FirebaseOptions | undefined;
267-
//let serverAppSettings: FirebaseServerAppSettings = _serverAppConfig || { };
268268
let serverAppSettings: FirebaseServerAppSettings = _serverAppConfig || {};
269269

270-
console.log('options: ', _options);
271-
console.log('_serverAppConfig: ', _serverAppConfig);
272-
273270
if (_options) {
274271
if (_isFirebaseApp(_options)) {
275-
console.log('_isFirebaseApp');
276272
app = _options;
277273
firebaseOptions = app.options;
278-
/*serverAppSettings = {
279-
...serverAppSettings,
280-
..._serverAppConfig
281-
};*/
282274
} else if (_isFirebaseServerAppSettings(_options)) {
283-
console.log('_isFirebaseServerAppSettings');
284275
serverAppSettings = _options;
285-
/*serverAppSettings = {
286-
...serverAppSettings,
287-
..._options
288-
};*/
289276
} else {
290-
console.log('isFirebaseOptions');
291277
firebaseOptions = _options;
292278
}
293279
}
@@ -303,11 +289,6 @@ export function initializeServerApp(
303289
...firebaseOptions
304290
};
305291

306-
console.log('Final:');
307-
console.log('app: ', app!);
308-
console.log('firebaseOptions: ', firebaseOptions);
309-
console.log('serverAppSettings: ', serverAppSettings);
310-
311292
// However, Do not mangle the name based on releaseOnDeref, since it will vary between the
312293
// construction of FirebaseServerApp instances. For example, if the object is the request headers.
313294
if (nameObj.releaseOnDeref !== undefined) {

0 commit comments

Comments
 (0)