@firebase/app

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

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"

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

The settable config flag for GDPR opt-in/opt-out. Defaults to true.

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

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

Unique identifier for the app.

Auth domain for the project ID.

Default Realtime Database URL.

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.

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

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

The default Cloud Storage bucket name.

There is no getApp() operation for FirebaseServerApp, so the name is not relevant for applications. However, it may be used internally, and is declared here so that FirebaseServerApp conforms to the FirebaseApp interface.

The (read-only) configuration settings for this server app. These are the original parameters given in initializeServerApp().

Example 1

const app = initializeServerApp(settings);
console.log(app.settings.authIdToken === options.authIdToken);  // true

An optional App Check token. If provided, the Firebase SDKs that use App Check will utilize this App Check token in place of requiring an instance of App Check to be initialized.

If the token fails local verification due to expiration or parsing errors, then a console error is logged at the time of initialization of the FirebaseServerApp instance.

An optional Auth ID token used to resume a signed in user session from a client runtime environment.

Invoking getAuth with a FirebaseServerApp configured with a validated authIdToken causes an automatic attempt to sign in the user that the authIdToken represents. The token needs to have been recently minted for this operation to succeed.

If the token fails local verification due to expiration or parsing errors, then a console error is logged at the time of initialization of the FirebaseServerApp instance.

If the Auth service has failed to validate the token when the Auth SDK is initialized, then an warning is logged to the console and the Auth SDK will not sign in a user on initialization.

If a user is successfully signed in, then the Auth instance's onAuthStateChanged callback is invoked with the User object as per standard Auth flows. However, User objects created via an authIdToken do not have a refresh token. Attempted refreshToken operations fail.

An optional object. If provided, the Firebase SDK uses a FinalizationRegistry object to monitor the garbage collection status of the provided object. The Firebase SDK releases its reference on the FirebaseServerApp instance when the provided releaseOnDeref object is garbage collected.

You can use this field to reduce memory management overhead for your application. If provided, an app running in a SSR pass does not need to perform FirebaseServerApp cleanup, so long as the reference object is deleted (by falling out of SSR scope, for instance.)

If an object is not provided then the application must clean up the FirebaseServerApp instance by invoking deleteApp.

If the application provides an object in this parameter, but the application is executed in a JavaScript engine that predates the support of FinalizationRegistry (introduced in node v14.6.0, for instance), then an error is thrown at FirebaseServerApp initialization.