123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311 |
- /**
- * Firebase App
- *
- * @remarks This package coordinates the communication between the different Firebase components
- * @packageDocumentation
- */
-
- import { Component } from '@firebase/component';
- import { ComponentContainer } from '@firebase/component';
- import { FirebaseError } from '@firebase/util';
- import { LogCallback } from '@firebase/logger';
- import { LogLevelString } from '@firebase/logger';
- import { LogOptions } from '@firebase/logger';
- import { Name } from '@firebase/component';
- import { Provider } from '@firebase/component';
-
- /* Excluded from this release type: _addComponent */
-
- /* Excluded from this release type: _addOrOverwriteComponent */
-
- /* Excluded from this release type: _apps */
-
- /* Excluded from this release type: _clearComponents */
-
- /* Excluded from this release type: _components */
-
- /* Excluded from this release type: _DEFAULT_ENTRY_NAME */
-
- /**
- * Renders this app unusable and frees the resources of all associated
- * services.
- *
- * @example
- * ```javascript
- * deleteApp(app)
- * .then(function() {
- * console.log("App deleted successfully");
- * })
- * .catch(function(error) {
- * console.log("Error deleting app:", error);
- * });
- * ```
- *
- * @public
- */
- export declare function deleteApp(app: FirebaseApp): Promise<void>;
-
- /**
- * A {@link @firebase/app#FirebaseApp} holds the initialization information for a collection of
- * services.
- *
- * Do not call this constructor directly. Instead, use
- * {@link (initializeApp:1) | initializeApp()} to create an app.
- *
- * @public
- */
- export declare interface FirebaseApp {
- /**
- * The (read-only) name for this app.
- *
- * The default app's name is `"[DEFAULT]"`.
- *
- * @example
- * ```javascript
- * // The default app's name is "[DEFAULT]"
- * const app = initializeApp(defaultAppConfig);
- * console.log(app.name); // "[DEFAULT]"
- * ```
- *
- * @example
- * ```javascript
- * // A named app's name is what you provide to initializeApp()
- * const otherApp = initializeApp(otherAppConfig, "other");
- * console.log(otherApp.name); // "other"
- * ```
- */
- readonly name: string;
- /**
- * The (read-only) configuration options for this app. These are the original
- * parameters given in {@link (initializeApp:1) | initializeApp()}.
- *
- * @example
- * ```javascript
- * const app = initializeApp(config);
- * console.log(app.options.databaseURL === config.databaseURL); // true
- * ```
- */
- readonly options: FirebaseOptions;
- /**
- * The settable config flag for GDPR opt-in/opt-out
- */
- automaticDataCollectionEnabled: boolean;
- }
-
- /* Excluded from this release type: _FirebaseAppInternal */
-
- /**
- * @public
- *
- * Configuration options given to {@link (initializeApp:1) | initializeApp()}
- */
- export declare interface FirebaseAppSettings {
- /**
- * custom name for the Firebase App.
- * The default value is `"[DEFAULT]"`.
- */
- name?: string;
- /**
- * The settable config flag for GDPR opt-in/opt-out
- */
- automaticDataCollectionEnabled?: boolean;
- }
- export { FirebaseError }
-
- /**
- * @public
- *
- * Firebase configuration object. Contains a set of parameters required by
- * services in order to successfully communicate with Firebase server APIs
- * and to associate client data with your Firebase project and
- * Firebase application. Typically this object is populated by the Firebase
- * console at project setup. See also:
- * {@link https://firebase.google.com/docs/web/setup#config-object | Learn about the Firebase config object}.
- */
- export declare interface FirebaseOptions {
- /**
- * An encrypted string used when calling certain APIs that don't need to
- * access private user data
- * (example value: `AIzaSyDOCAbC123dEf456GhI789jKl012-MnO`).
- */
- apiKey?: string;
- /**
- * Auth domain for the project ID.
- */
- authDomain?: string;
- /**
- * Default Realtime Database URL.
- */
- databaseURL?: string;
- /**
- * The unique identifier for the project across all of Firebase and
- * Google Cloud.
- */
- projectId?: string;
- /**
- * The default Cloud Storage bucket name.
- */
- storageBucket?: string;
- /**
- * Unique numerical value used to identify each sender that can send
- * Firebase Cloud Messaging messages to client apps.
- */
- messagingSenderId?: string;
- /**
- * Unique identifier for the app.
- */
- appId?: string;
- /**
- * An ID automatically created when you enable Analytics in your
- * Firebase project and register a web app. In versions 7.20.0
- * and higher, this parameter is optional.
- */
- measurementId?: string;
- }
-
- /* Excluded from this release type: _FirebaseService */
-
- /**
- * Retrieves a {@link @firebase/app#FirebaseApp} instance.
- *
- * When called with no arguments, the default app is returned. When an app name
- * is provided, the app corresponding to that name is returned.
- *
- * An exception is thrown if the app being retrieved has not yet been
- * initialized.
- *
- * @example
- * ```javascript
- * // Return the default app
- * const app = getApp();
- * ```
- *
- * @example
- * ```javascript
- * // Return a named app
- * const otherApp = getApp("otherApp");
- * ```
- *
- * @param name - Optional name of the app to return. If no name is
- * provided, the default is `"[DEFAULT]"`.
- *
- * @returns The app corresponding to the provided app name.
- * If no app name is provided, the default app is returned.
- *
- * @public
- */
- export declare function getApp(name?: string): FirebaseApp;
-
- /**
- * A (read-only) array of all initialized apps.
- * @public
- */
- export declare function getApps(): FirebaseApp[];
-
- /* Excluded from this release type: _getProvider */
-
- /**
- * Creates and initializes a {@link @firebase/app#FirebaseApp} instance.
- *
- * See
- * {@link
- * https://firebase.google.com/docs/web/setup#add_firebase_to_your_app
- * | Add Firebase to your app} and
- * {@link
- * https://firebase.google.com/docs/web/setup#multiple-projects
- * | Initialize multiple projects} for detailed documentation.
- *
- * @example
- * ```javascript
- *
- * // Initialize default app
- * // Retrieve your own options values by adding a web app on
- * // https://console.firebase.google.com
- * initializeApp({
- * apiKey: "AIza....", // Auth / General Use
- * authDomain: "YOUR_APP.firebaseapp.com", // Auth with popup/redirect
- * databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
- * storageBucket: "YOUR_APP.appspot.com", // Storage
- * messagingSenderId: "123456789" // Cloud Messaging
- * });
- * ```
- *
- * @example
- * ```javascript
- *
- * // Initialize another app
- * const otherApp = initializeApp({
- * databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
- * storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
- * }, "otherApp");
- * ```
- *
- * @param options - Options to configure the app's services.
- * @param name - Optional name of the app to initialize. If no name
- * is provided, the default is `"[DEFAULT]"`.
- *
- * @returns The initialized app.
- *
- * @public
- */
- export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
-
- /**
- * Creates and initializes a FirebaseApp instance.
- *
- * @param options - Options to configure the app's services.
- * @param config - FirebaseApp Configuration
- *
- * @public
- */
- export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
-
- /**
- * Creates and initializes a FirebaseApp instance.
- *
- * @public
- */
- export declare function initializeApp(): FirebaseApp;
-
- /**
- * Sets log handler for all Firebase SDKs.
- * @param logCallback - An optional custom log handler that executes user code whenever
- * the Firebase SDK makes a logging call.
- *
- * @public
- */
- export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
-
- /* Excluded from this release type: _registerComponent */
-
- /**
- * Registers a library's name and version for platform logging purposes.
- * @param library - Name of 1p or 3p library (e.g. firestore, angularfire)
- * @param version - Current version of that library.
- * @param variant - Bundle variant, e.g., node, rn, etc.
- *
- * @public
- */
- export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
-
- /* Excluded from this release type: _removeServiceInstance */
-
- /**
- * The current SDK version.
- *
- * @public
- */
- export declare const SDK_VERSION: string;
-
- /**
- * Sets log level for all Firebase SDKs.
- *
- * All of the log types above the current log level are captured (i.e. if
- * you set the log level to `info`, errors are logged, but `debug` and
- * `verbose` logs are not).
- *
- * @public
- */
- export declare function setLogLevel(logLevel: LogLevelString): void;
-
- export { }
|