Files
Mark DuckworthandGitHub 017073ed9b Fix documentation links for function overloads and improve readability of function headings (#7864)
* Support function links to function overloads.

* Improve readability of headings for functions.
2023-12-15 16:17:10 -07:00

2.4 KiB

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

FirebaseApp interface

A FirebaseApp holds the initialization information for a collection of services.

Do not call this constructor directly. Instead, use initializeApp() to create an app.

Signature:

export interface FirebaseApp 

Properties

Property Type Description
automaticDataCollectionEnabled boolean The settable config flag for GDPR opt-in/opt-out
name string The (read-only) name for this app.The default app's name is "[DEFAULT]".
options FirebaseOptions The (read-only) configuration options for this app. These are the original parameters given in initializeApp().

FirebaseApp.automaticDataCollectionEnabled

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

Signature:

automaticDataCollectionEnabled: boolean;

FirebaseApp.name

The (read-only) name for this app.

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

Signature:

readonly name: string;

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"

FirebaseApp.options

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

Signature:

readonly options: FirebaseOptions;

Example

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