Logo for jsDocs.io

@firebase/app

  • Version 0.9.11
  • Published
  • 398 kB
  • 5 dependencies
  • Apache-2.0 license

Install

npm i @firebase/app
yarn add @firebase/app
pnpm add @firebase/app

Overview

Firebase App

Remarks

This package coordinates the communication between the different Firebase components

Index

Variables

Functions

Interfaces

Variables

variable SDK_VERSION

const SDK_VERSION: string;

  • The current SDK version.

    Modifiers

    • @public

Functions

function deleteApp

deleteApp: (app: FirebaseApp) => Promise<void>;

  • Renders this app unusable and frees the resources of all associated services.

    Example 1

    deleteApp(app)
      .then(function() {
        console.log("App deleted successfully");
      })
      .catch(function(error) {
        console.log("Error deleting app:", error);
      });

    Modifiers

    • @public

function getApp

getApp: (name?: string) => FirebaseApp;

  • Retrieves a @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.

    Parameter 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.

    Example 1

    // Return the default app
    const app = getApp();

    Example 2

    // Return a named app
    const otherApp = getApp("otherApp");

    Modifiers

    • @public

function getApps

getApps: () => FirebaseApp[];

  • A (read-only) array of all initialized apps.

    Modifiers

    • @public

function initializeApp

initializeApp: {
    (options: FirebaseOptions, name?: string): FirebaseApp;
    (options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
    (): FirebaseApp;
};

  • Creates and initializes a @firebase/app#FirebaseApp instance.

    See Add Firebase to your app and Initialize multiple projects for detailed documentation.

    Parameter options

    Options to configure the app's services.

    Parameter name

    Optional name of the app to initialize. If no name is provided, the default is "[DEFAULT]".

    Returns

    The initialized app.

    Example 1

    // 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 2

    // Initialize another app
    const otherApp = initializeApp({
      databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
      storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
    }, "otherApp");

    Modifiers

    • @public

  • Creates and initializes a FirebaseApp instance.

    Parameter options

    Options to configure the app's services.

    Parameter config

    FirebaseApp Configuration

    Modifiers

    • @public

  • Creates and initializes a FirebaseApp instance.

    Modifiers

    • @public

function onLog

onLog: (logCallback: LogCallback | null, options?: LogOptions) => void;

  • Sets log handler for all Firebase SDKs.

    Parameter logCallback

    An optional custom log handler that executes user code whenever the Firebase SDK makes a logging call.

    Modifiers

    • @public

function registerVersion

registerVersion: (
    libraryKeyOrName: string,
    version: string,
    variant?: string
) => void;

  • Registers a library's name and version for platform logging purposes.

    Parameter library

    Name of 1p or 3p library (e.g. firestore, angularfire)

    Parameter version

    Current version of that library.

    Parameter variant

    Bundle variant, e.g., node, rn, etc.

    Modifiers

    • @public

function setLogLevel

setLogLevel: (logLevel: LogLevelString) => void;

  • 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).

    Modifiers

    • @public

Interfaces

interface FirebaseApp

interface FirebaseApp {}

property automaticDataCollectionEnabled

automaticDataCollectionEnabled: boolean;

  • The settable config flag for GDPR opt-in/opt-out

property name

readonly name: string;

  • The (read-only) name for this app.

    The default app's name is "[DEFAULT]".

    Example 1

    // The default app's name is "[DEFAULT]"
    const app = initializeApp(defaultAppConfig);
    console.log(app.name);  // "[DEFAULT]"

    Example 2

    // A named app's name is what you provide to initializeApp()
    const otherApp = initializeApp(otherAppConfig, "other");
    console.log(otherApp.name);  // "other"

property options

readonly options: FirebaseOptions;

  • The (read-only) configuration options for this app. These are the original parameters given in initializeApp().

    Example 1

    const app = initializeApp(config);
    console.log(app.options.databaseURL === config.databaseURL);  // true

interface FirebaseAppSettings

interface FirebaseAppSettings {}

property automaticDataCollectionEnabled

automaticDataCollectionEnabled?: boolean;

  • The settable config flag for GDPR opt-in/opt-out

property name

name?: string;

  • custom name for the Firebase App. The default value is "[DEFAULT]".

interface FirebaseOptions

interface FirebaseOptions {}

  • 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: Learn about the Firebase config object.

    Modifiers

    • @public

property apiKey

apiKey?: string;

  • An encrypted string used when calling certain APIs that don't need to access private user data (example value: AIzaSyDOCAbC123dEf456GhI789jKl012-MnO).

property appId

appId?: string;

  • Unique identifier for the app.

property authDomain

authDomain?: string;

  • Auth domain for the project ID.

property databaseURL

databaseURL?: string;

  • Default Realtime Database URL.

property measurementId

measurementId?: 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.

property messagingSenderId

messagingSenderId?: string;

  • Unique numerical value used to identify each sender that can send Firebase Cloud Messaging messages to client apps.

property projectId

projectId?: string;

  • The unique identifier for the project across all of Firebase and Google Cloud.

property storageBucket

storageBucket?: string;

  • The default Cloud Storage bucket name.

Package Files (1)

Dependencies (5)

Dev Dependencies (5)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@firebase/app.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@firebase/app)
  • HTML
    <a href="https://www.jsdocs.io/package/@firebase/app"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>