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 %}

FirebaseOptions interface

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

<b>Signature:</b>

export interface FirebaseOptions 

Properties

FirebaseOptions.apiKey

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

<b>Signature:</b>

apiKey?: string;

FirebaseOptions.appId

Unique identifier for the app.

<b>Signature:</b>

appId?: string;

FirebaseOptions.authDomain

Auth domain for the project ID.

<b>Signature:</b>

authDomain?: string;

FirebaseOptions.databaseURL

Default Realtime Database URL.

<b>Signature:</b>

databaseURL?: string;

FirebaseOptions.measurementId

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.

<b>Signature:</b>

measurementId?: string;

FirebaseOptions.messagingSenderId

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

<b>Signature:</b>

messagingSenderId?: string;

FirebaseOptions.projectId

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

<b>Signature:</b>

projectId?: string;

FirebaseOptions.storageBucket

The default Cloud Storage bucket name.

<b>Signature:</b>

storageBucket?: string;