@firebase/app 0.13.2-canary.d91169f06 → 0.13.2-canary.f11b55294

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -65,10 +65,6 @@ export declare const SDK_VERSION: string;
65
65
  *
66
66
  * @returns The initialized app.
67
67
  *
68
- * @throws If the optional `name` parameter is malformed or empty.
69
- *
70
- * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
71
- *
72
68
  * @public
73
69
  */
74
70
  export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
@@ -78,9 +74,6 @@ export declare function initializeApp(options: FirebaseOptions, name?: string):
78
74
  * @param options - Options to configure the app's services.
79
75
  * @param config - FirebaseApp Configuration
80
76
  *
81
- * @throws If {@link FirebaseAppSettings.name} is defined but the value is malformed or empty.
82
- *
83
- * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
84
77
  * @public
85
78
  */
86
79
  export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
@@ -125,34 +118,13 @@ export declare function initializeApp(): FirebaseApp;
125
118
  *
126
119
  * @param options - `Firebase.AppOptions` to configure the app's services, or a
127
120
  * a `FirebaseApp` instance which contains the `AppOptions` within.
128
- * @param config - Optional `FirebaseServerApp` settings.
129
- *
130
- * @returns The initialized `FirebaseServerApp`.
131
- *
132
- * @throws If invoked in an unsupported non-server environment such as a browser.
133
- *
134
- * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
135
- * provide Finalization Registry support.
136
- *
137
- * @public
138
- */
139
- export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config?: FirebaseServerAppSettings): FirebaseServerApp;
140
- /**
141
- * Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
142
- *
143
- * @param config - Optional `FirebaseServerApp` settings.
121
+ * @param config - `FirebaseServerApp` configuration.
144
122
  *
145
123
  * @returns The initialized `FirebaseServerApp`.
146
124
  *
147
- * @throws If invoked in an unsupported non-server environment such as a browser.
148
- * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
149
- * provide Finalization Registry support.
150
- * @throws If the `FIREBASE_OPTIONS` enviornment variable does not contain a valid project
151
- * configuration required for auto-initialization.
152
- *
153
125
  * @public
154
126
  */
155
- export declare function initializeServerApp(config?: FirebaseServerAppSettings): FirebaseServerApp;
127
+ export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
156
128
  /**
157
129
  * Retrieves a {@link @firebase/app#FirebaseApp} instance.
158
130
  *
@@ -641,10 +641,6 @@ declare const SDK_VERSION: string;
641
641
  *
642
642
  * @returns The initialized app.
643
643
  *
644
- * @throws If the optional `name` parameter is malformed or empty.
645
- *
646
- * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
647
- *
648
644
  * @public
649
645
  */
650
646
  declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
@@ -654,9 +650,6 @@ declare function initializeApp(options: FirebaseOptions, name?: string): Firebas
654
650
  * @param options - Options to configure the app's services.
655
651
  * @param config - FirebaseApp Configuration
656
652
  *
657
- * @throws If {@link FirebaseAppSettings.name} is defined but the value is malformed or empty.
658
- *
659
- * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
660
653
  * @public
661
654
  */
662
655
  declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
@@ -701,34 +694,13 @@ declare function initializeApp(): FirebaseApp;
701
694
  *
702
695
  * @param options - `Firebase.AppOptions` to configure the app's services, or a
703
696
  * a `FirebaseApp` instance which contains the `AppOptions` within.
704
- * @param config - Optional `FirebaseServerApp` settings.
697
+ * @param config - `FirebaseServerApp` configuration.
705
698
  *
706
699
  * @returns The initialized `FirebaseServerApp`.
707
700
  *
708
- * @throws If invoked in an unsupported non-server environment such as a browser.
709
- *
710
- * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
711
- * provide Finalization Registry support.
712
- *
713
701
  * @public
714
702
  */
715
- declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config?: FirebaseServerAppSettings): FirebaseServerApp;
716
- /**
717
- * Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
718
- *
719
- * @param config - Optional `FirebaseServerApp` settings.
720
- *
721
- * @returns The initialized `FirebaseServerApp`.
722
- *
723
- * @throws If invoked in an unsupported non-server environment such as a browser.
724
- * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
725
- * provide Finalization Registry support.
726
- * @throws If the `FIREBASE_OPTIONS` enviornment variable does not contain a valid project
727
- * configuration required for auto-initialization.
728
- *
729
- * @public
730
- */
731
- declare function initializeServerApp(config?: FirebaseServerAppSettings): FirebaseServerApp;
703
+ declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
732
704
  /**
733
705
  * Retrieves a {@link @firebase/app#FirebaseApp} instance.
734
706
  *
@@ -904,22 +876,13 @@ declare function _getProvider<T extends Name>(app: FirebaseApp, name: T): Provid
904
876
  declare function _removeServiceInstance<T extends Name>(app: FirebaseApp, name: T, instanceIdentifier?: string): void;
905
877
  /**
906
878
  *
907
- * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
879
+ * @param obj - an object of type FirebaseApp or FirebaseOptions.
908
880
  *
909
881
  * @returns true if the provide object is of type FirebaseApp.
910
882
  *
911
883
  * @internal
912
884
  */
913
- declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseApp;
914
- /**
915
- *
916
- * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
917
- *
918
- * @returns true if the provided object is of type FirebaseServerAppImpl.
919
- *
920
- * @internal
921
- */
922
- declare function _isFirebaseServerAppSettings(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseServerAppSettings;
885
+ declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions): obj is FirebaseApp;
923
886
  /**
924
887
  *
925
888
  * @param obj - an object of type FirebaseApp.
@@ -936,4 +899,4 @@ declare function _isFirebaseServerApp(obj: FirebaseApp | FirebaseServerApp | nul
936
899
  */
937
900
  declare function _clearComponents(): void;
938
901
 
939
- export { FirebaseApp, FirebaseAppSettings, FirebaseError, FirebaseOptions, FirebaseServerApp, FirebaseServerAppSettings, SDK_VERSION, DEFAULT_ENTRY_NAME as _DEFAULT_ENTRY_NAME, _FirebaseAppInternal, _FirebaseService, _addComponent, _addOrOverwriteComponent, _apps, _clearComponents, _components, _getProvider, _isFirebaseApp, _isFirebaseServerApp, _isFirebaseServerAppSettings, _registerComponent, _removeServiceInstance, _serverApps, deleteApp, getApp, getApps, initializeApp, initializeServerApp, onLog, registerVersion, setLogLevel };
902
+ export { FirebaseApp, FirebaseAppSettings, FirebaseError, FirebaseOptions, FirebaseServerApp, FirebaseServerAppSettings, SDK_VERSION, DEFAULT_ENTRY_NAME as _DEFAULT_ENTRY_NAME, _FirebaseAppInternal, _FirebaseService, _addComponent, _addOrOverwriteComponent, _apps, _clearComponents, _components, _getProvider, _isFirebaseApp, _isFirebaseServerApp, _registerComponent, _removeServiceInstance, _serverApps, deleteApp, getApp, getApps, initializeApp, initializeServerApp, onLog, registerVersion, setLogLevel };
@@ -14,7 +14,7 @@
14
14
  * See the License for the specific language governing permissions and
15
15
  * limitations under the License.
16
16
  */
17
- import { FirebaseApp, FirebaseAppSettings, FirebaseServerAppSettings, FirebaseOptions, FirebaseServerApp } from './public-types';
17
+ import { FirebaseApp, FirebaseOptions, FirebaseServerApp } from './public-types';
18
18
  import { Component, Provider, Name } from '@firebase/component';
19
19
  import { DEFAULT_ENTRY_NAME } from './constants';
20
20
  /**
@@ -71,22 +71,13 @@ export declare function _getProvider<T extends Name>(app: FirebaseApp, name: T):
71
71
  export declare function _removeServiceInstance<T extends Name>(app: FirebaseApp, name: T, instanceIdentifier?: string): void;
72
72
  /**
73
73
  *
74
- * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
74
+ * @param obj - an object of type FirebaseApp or FirebaseOptions.
75
75
  *
76
76
  * @returns true if the provide object is of type FirebaseApp.
77
77
  *
78
78
  * @internal
79
79
  */
80
- export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseApp;
81
- /**
82
- *
83
- * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
84
- *
85
- * @returns true if the provided object is of type FirebaseServerAppImpl.
86
- *
87
- * @internal
88
- */
89
- export declare function _isFirebaseServerAppSettings(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseServerAppSettings;
80
+ export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions): obj is FirebaseApp;
90
81
  /**
91
82
  *
92
83
  * @param obj - an object of type FirebaseApp.
@@ -332,10 +332,6 @@ export declare function getApps(): FirebaseApp[];
332
332
  *
333
333
  * @returns The initialized app.
334
334
  *
335
- * @throws If the optional `name` parameter is malformed or empty.
336
- *
337
- * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
338
- *
339
335
  * @public
340
336
  */
341
337
  export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
@@ -346,9 +342,6 @@ export declare function initializeApp(options: FirebaseOptions, name?: string):
346
342
  * @param options - Options to configure the app's services.
347
343
  * @param config - FirebaseApp Configuration
348
344
  *
349
- * @throws If {@link FirebaseAppSettings.name} is defined but the value is malformed or empty.
350
- *
351
- * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
352
345
  * @public
353
346
  */
354
347
  export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
@@ -395,42 +388,18 @@ export declare function initializeApp(): FirebaseApp;
395
388
  *
396
389
  * @param options - `Firebase.AppOptions` to configure the app's services, or a
397
390
  * a `FirebaseApp` instance which contains the `AppOptions` within.
398
- * @param config - Optional `FirebaseServerApp` settings.
399
- *
400
- * @returns The initialized `FirebaseServerApp`.
401
- *
402
- * @throws If invoked in an unsupported non-server environment such as a browser.
403
- *
404
- * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
405
- * provide Finalization Registry support.
406
- *
407
- * @public
408
- */
409
- export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config?: FirebaseServerAppSettings): FirebaseServerApp;
410
-
411
- /**
412
- * Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
413
- *
414
- * @param config - Optional `FirebaseServerApp` settings.
391
+ * @param config - `FirebaseServerApp` configuration.
415
392
  *
416
393
  * @returns The initialized `FirebaseServerApp`.
417
394
  *
418
- * @throws If invoked in an unsupported non-server environment such as a browser.
419
- * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
420
- * provide Finalization Registry support.
421
- * @throws If the `FIREBASE_OPTIONS` enviornment variable does not contain a valid project
422
- * configuration required for auto-initialization.
423
- *
424
395
  * @public
425
396
  */
426
- export declare function initializeServerApp(config?: FirebaseServerAppSettings): FirebaseServerApp;
397
+ export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
427
398
 
428
399
  /* Excluded from this release type: _isFirebaseApp */
429
400
 
430
401
  /* Excluded from this release type: _isFirebaseServerApp */
431
402
 
432
- /* Excluded from this release type: _isFirebaseServerAppSettings */
433
-
434
403
  /**
435
404
  * Sets log handler for all Firebase SDKs.
436
405
  * @param logCallback - An optional custom log handler that executes user code whenever
package/dist/app.d.ts CHANGED
@@ -385,10 +385,6 @@ export declare function _getProvider<T extends Name>(app: FirebaseApp, name: T):
385
385
  *
386
386
  * @returns The initialized app.
387
387
  *
388
- * @throws If the optional `name` parameter is malformed or empty.
389
- *
390
- * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
391
- *
392
388
  * @public
393
389
  */
394
390
  export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
@@ -399,9 +395,6 @@ export declare function initializeApp(options: FirebaseOptions, name?: string):
399
395
  * @param options - Options to configure the app's services.
400
396
  * @param config - FirebaseApp Configuration
401
397
  *
402
- * @throws If {@link FirebaseAppSettings.name} is defined but the value is malformed or empty.
403
- *
404
- * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
405
398
  * @public
406
399
  */
407
400
  export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
@@ -448,45 +441,23 @@ export declare function initializeApp(): FirebaseApp;
448
441
  *
449
442
  * @param options - `Firebase.AppOptions` to configure the app's services, or a
450
443
  * a `FirebaseApp` instance which contains the `AppOptions` within.
451
- * @param config - Optional `FirebaseServerApp` settings.
444
+ * @param config - `FirebaseServerApp` configuration.
452
445
  *
453
446
  * @returns The initialized `FirebaseServerApp`.
454
447
  *
455
- * @throws If invoked in an unsupported non-server environment such as a browser.
456
- *
457
- * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
458
- * provide Finalization Registry support.
459
- *
460
448
  * @public
461
449
  */
462
- export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config?: FirebaseServerAppSettings): FirebaseServerApp;
450
+ export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
463
451
 
464
452
  /**
465
- * Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
466
453
  *
467
- * @param config - Optional `FirebaseServerApp` settings.
468
- *
469
- * @returns The initialized `FirebaseServerApp`.
470
- *
471
- * @throws If invoked in an unsupported non-server environment such as a browser.
472
- * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
473
- * provide Finalization Registry support.
474
- * @throws If the `FIREBASE_OPTIONS` enviornment variable does not contain a valid project
475
- * configuration required for auto-initialization.
476
- *
477
- * @public
478
- */
479
- export declare function initializeServerApp(config?: FirebaseServerAppSettings): FirebaseServerApp;
480
-
481
- /**
482
- *
483
- * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
454
+ * @param obj - an object of type FirebaseApp or FirebaseOptions.
484
455
  *
485
456
  * @returns true if the provide object is of type FirebaseApp.
486
457
  *
487
458
  * @internal
488
459
  */
489
- export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseApp;
460
+ export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions): obj is FirebaseApp;
490
461
 
491
462
  /**
492
463
  *
@@ -498,16 +469,6 @@ export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions | Fire
498
469
  */
499
470
  export declare function _isFirebaseServerApp(obj: FirebaseApp | FirebaseServerApp | null | undefined): obj is FirebaseServerApp;
500
471
 
501
- /**
502
- *
503
- * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
504
- *
505
- * @returns true if the provided object is of type FirebaseServerAppImpl.
506
- *
507
- * @internal
508
- */
509
- export declare function _isFirebaseServerAppSettings(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseServerAppSettings;
510
-
511
472
  /**
512
473
  * Sets log handler for all Firebase SDKs.
513
474
  * @param logCallback - An optional custom log handler that executes user code whenever
@@ -65,10 +65,6 @@ export declare const SDK_VERSION: string;
65
65
  *
66
66
  * @returns The initialized app.
67
67
  *
68
- * @throws If the optional `name` parameter is malformed or empty.
69
- *
70
- * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
71
- *
72
68
  * @public
73
69
  */
74
70
  export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
@@ -78,9 +74,6 @@ export declare function initializeApp(options: FirebaseOptions, name?: string):
78
74
  * @param options - Options to configure the app's services.
79
75
  * @param config - FirebaseApp Configuration
80
76
  *
81
- * @throws If {@link FirebaseAppSettings.name} is defined but the value is malformed or empty.
82
- *
83
- * @throws If a `FirebaseApp` already exists with the same name but with a different configuration.
84
77
  * @public
85
78
  */
86
79
  export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
@@ -125,34 +118,13 @@ export declare function initializeApp(): FirebaseApp;
125
118
  *
126
119
  * @param options - `Firebase.AppOptions` to configure the app's services, or a
127
120
  * a `FirebaseApp` instance which contains the `AppOptions` within.
128
- * @param config - Optional `FirebaseServerApp` settings.
129
- *
130
- * @returns The initialized `FirebaseServerApp`.
131
- *
132
- * @throws If invoked in an unsupported non-server environment such as a browser.
133
- *
134
- * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
135
- * provide Finalization Registry support.
136
- *
137
- * @public
138
- */
139
- export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config?: FirebaseServerAppSettings): FirebaseServerApp;
140
- /**
141
- * Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
142
- *
143
- * @param config - Optional `FirebaseServerApp` settings.
121
+ * @param config - `FirebaseServerApp` configuration.
144
122
  *
145
123
  * @returns The initialized `FirebaseServerApp`.
146
124
  *
147
- * @throws If invoked in an unsupported non-server environment such as a browser.
148
- * @throws If {@link FirebaseServerAppSettings.releaseOnDeref} is defined but the runtime doesn't
149
- * provide Finalization Registry support.
150
- * @throws If the `FIREBASE_OPTIONS` enviornment variable does not contain a valid project
151
- * configuration required for auto-initialization.
152
- *
153
125
  * @public
154
126
  */
155
- export declare function initializeServerApp(config?: FirebaseServerAppSettings): FirebaseServerApp;
127
+ export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
156
128
  /**
157
129
  * Retrieves a {@link @firebase/app#FirebaseApp} instance.
158
130
  *
@@ -14,7 +14,7 @@
14
14
  * See the License for the specific language governing permissions and
15
15
  * limitations under the License.
16
16
  */
17
- import { FirebaseApp, FirebaseAppSettings, FirebaseServerAppSettings, FirebaseOptions, FirebaseServerApp } from './public-types';
17
+ import { FirebaseApp, FirebaseOptions, FirebaseServerApp } from './public-types';
18
18
  import { Component, Provider, Name } from '@firebase/component';
19
19
  import { DEFAULT_ENTRY_NAME } from './constants';
20
20
  /**
@@ -71,22 +71,13 @@ export declare function _getProvider<T extends Name>(app: FirebaseApp, name: T):
71
71
  export declare function _removeServiceInstance<T extends Name>(app: FirebaseApp, name: T, instanceIdentifier?: string): void;
72
72
  /**
73
73
  *
74
- * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
74
+ * @param obj - an object of type FirebaseApp or FirebaseOptions.
75
75
  *
76
76
  * @returns true if the provide object is of type FirebaseApp.
77
77
  *
78
78
  * @internal
79
79
  */
80
- export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseApp;
81
- /**
82
- *
83
- * @param obj - an object of type FirebaseApp, FirebaseOptions or FirebaseAppSettings.
84
- *
85
- * @returns true if the provided object is of type FirebaseServerAppImpl.
86
- *
87
- * @internal
88
- */
89
- export declare function _isFirebaseServerAppSettings(obj: FirebaseApp | FirebaseOptions | FirebaseAppSettings): obj is FirebaseServerAppSettings;
80
+ export declare function _isFirebaseApp(obj: FirebaseApp | FirebaseOptions): obj is FirebaseApp;
90
81
  /**
91
82
  *
92
83
  * @param obj - an object of type FirebaseApp.