[# Firebase JavaScript SDK Reference](https://firebase.google.com/docs/reference/js/v8#firebase-javascript-sdk-reference) The Firebase JavaScript SDK implements the client-side libraries used by applications using Firebase services. This SDK is distributed via: - [CDN](https://firebase.google.com/docs/web/setup#add-sdks-initialize) - [npm package](https://www.npmjs.com/package/firebase) To get started using Firebase, see [Add Firebase to your JavaScript Project](https://firebase.google.com/docs/web/setup). For source code, see the [Firebase JavaScript SDK Github repo](https://github.com/firebase/firebase-js-sdk). [# API Reference](https://firebase.google.com/docs/reference/js/v8#api-reference) [](https://firebase.google.com/docs/reference/js/v8#firebase) ## [firebase](https://firebase.google.com/docs/reference/js/v8/firebase) - [FirebaseError](https://firebase.google.com/docs/reference/js/v8/firebase.FirebaseError) - [FirebaseIdToken](https://firebase.google.com/docs/reference/js/v8/firebase.FirebaseIdToken) [](https://firebase.google.com/docs/reference/js/v8#firebaseapp) ## [firebase.app](https://firebase.google.com/docs/reference/js/v8/firebase.app) - [App](https://firebase.google.com/docs/reference/js/v8/firebase.app.App) [](https://firebase.google.com/docs/reference/js/v8#firebaseappcheck) ## [firebase.appcheck](https://firebase.google.com/docs/reference/js/v8/firebase.appcheck) - [AppCheck](https://firebase.google.com/docs/reference/js/v8/firebase.appcheck.AppCheck) - [AppCheckProvider](https://firebase.google.com/docs/reference/js/v8/firebase.appcheck.AppCheckProvider) - [AppCheckToken](https://firebase.google.com/docs/reference/js/v8/firebase.appcheck.AppCheckToken) - [AppCheckTokenResult](https://firebase.google.com/docs/reference/js/v8/firebase.appcheck.AppCheckTokenResult) - [CustomProvider](https://firebase.google.com/docs/reference/js/v8/firebase.appcheck.CustomProvider) - [CustomProviderOptions](https://firebase.google.com/docs/reference/js/v8/firebase.appcheck.CustomProviderOptions) - [ReCaptchaEnterpriseProvider](https://firebase.google.com/docs/reference/js/v8/firebase.appcheck.ReCaptchaEnterpriseProvider) - [ReCaptchaV3Provider](https://firebase.google.com/docs/reference/js/v8/firebase.appcheck.ReCaptchaV3Provider) [](https://firebase.google.com/docs/reference/js/v8#firebaseanalytics) ## [firebase.analytics](https://firebase.google.com/docs/reference/js/v8/firebase.analytics) - [Analytics](https://firebase.google.com/docs/reference/js/v8/firebase.analytics.Analytics) - [AnalyticsCallOptions](https://firebase.google.com/docs/reference/js/v8/firebase.analytics.AnalyticsCallOptions) - [SettingsOptions](https://firebase.google.com/docs/reference/js/v8/firebase.analytics.SettingsOptions) - [EventName](https://firebase.google.com/docs/reference/js/v8/firebase.analytics.EventName) - [ControlParams](https://firebase.google.com/docs/reference/js/v8/firebase.analytics.ControlParams) - [CustomParams](https://firebase.google.com/docs/reference/js/v8/firebase.analytics.CustomParams) - [EventParams](https://firebase.google.com/docs/reference/js/v8/firebase.analytics.EventParams) - [Item](https://firebase.google.com/docs/reference/js/v8/firebase.analytics.Item) - [Promotion](https://firebase.google.com/docs/reference/js/v8/firebase.analytics.Promotion) [](https://firebase.google.com/docs/reference/js/v8#firebaseauth) ## [firebase.auth](https://firebase.google.com/docs/reference/js/v8/firebase.auth) - [Auth](https://firebase.google.com/docs/reference/js/v8/firebase.auth.Auth) - [ActionCodeInfo](https://firebase.google.com/docs/reference/js/v8/firebase.auth.ActionCodeInfo) - [ActionCodeURL](https://firebase.google.com/docs/reference/js/v8/firebase.auth.ActionCodeURL) - [ApplicationVerifier](https://firebase.google.com/docs/reference/js/v8/firebase.auth.ApplicationVerifier) - [AuthCredential](https://firebase.google.com/docs/reference/js/v8/firebase.auth.AuthCredential) - [AuthError](https://firebase.google.com/docs/reference/js/v8/firebase.auth.AuthError) - [AuthProvider](https://firebase.google.com/docs/reference/js/v8/firebase.auth.AuthProvider) - [AuthSettings](https://firebase.google.com/docs/reference/js/v8/firebase.auth.AuthSettings) - [Config](https://firebase.google.com/docs/reference/js/v8/firebase.auth.Config) - [ConfirmationResult](https://firebase.google.com/docs/reference/js/v8/firebase.auth.ConfirmationResult) - [EmailAuthProvider](https://firebase.google.com/docs/reference/js/v8/firebase.auth.EmailAuthProvider) - [EmulatorConfig](https://firebase.google.com/docs/reference/js/v8/firebase.auth.EmulatorConfig) - [Error](https://firebase.google.com/docs/reference/js/v8/firebase.auth.Error) - [FacebookAuthProvider](https://firebase.google.com/docs/reference/js/v8/firebase.auth.FacebookAuthProvider) - [GithubAuthProvider](https://firebase.google.com/docs/reference/js/v8/firebase.auth.GithubAuthProvider) - [GoogleAuthProvider](https://firebase.google.com/docs/reference/js/v8/firebase.auth.GoogleAuthProvider) - [IdTokenResult](https://firebase.google.com/docs/reference/js/v8/firebase.auth.IDTokenResult) - [MultiFactorAssertion](https://firebase.google.com/docs/reference/js/v8/firebase.auth.MultiFactorAssertion) - [MultiFactorError](https://firebase.google.com/docs/reference/js/v8/firebase.auth.MultiFactorError) - [MultiFactorInfo](https://firebase.google.com/docs/reference/js/v8/firebase.auth.MultiFactorInfo) - [MultiFactorResolver](https://firebase.google.com/docs/reference/js/v8/firebase.auth.MultiFactorResolver) - [MultiFactorSession](https://firebase.google.com/docs/reference/js/v8/firebase.auth.MultiFactorSession) - [PhoneAuthCredential](https://firebase.google.com/docs/reference/js/v8/firebase.auth.PhoneAuthCredential) - [PhoneMultiFactorAssertion](https://firebase.google.com/docs/reference/js/v8/firebase.auth.PhoneMultiFactorAssertion) - [PhoneMultiFactorEnrollInfoOptions](https://firebase.google.com/docs/reference/js/v8/firebase.auth.PhoneMultiFactorEnrollInfoOptions) - [PhoneMultiFactorGenerator](https://firebase.google.com/docs/reference/js/v8/firebase.auth.PhoneMultiFactorGenerator) - [PhoneMultiFactorInfo](https://firebase.google.com/docs/reference/js/v8/firebase.auth.PhoneMultiFactorInfo) - [PhoneMultiFactorSignInInfoOptions](https://firebase.google.com/docs/reference/js/v8/firebase.auth.PhoneMultiFactorSignInInfoOptions) - [PhoneSingleFactorInfoOptions](https://firebase.google.com/docs/reference/js/v8/firebase.auth.PhoneSingleFactorInfoOptions) - [MultiFactorUser](https://firebase.google.com/docs/reference/js/v8/firebase.user.MultiFactorUser) - [OAuthCredential](https://firebase.google.com/docs/reference/js/v8/firebase.auth.OAuthCredential) - [OAuthCredentialOptions](https://firebase.google.com/docs/reference/js/v8/firebase.auth.OAuthCredentialOptions) - [OAuthProvider](https://firebase.google.com/docs/reference/js/v8/firebase.auth.OAuthProvider) - [PhoneAuthProvider](https://firebase.google.com/docs/reference/js/v8/firebase.auth.PhoneAuthProvider) - [RecaptchaVerifier](https://firebase.google.com/docs/reference/js/v8/firebase.auth.RecaptchaVerifier) - [SAMLAuthProvider](https://firebase.google.com/docs/reference/js/v8/firebase.auth.SAMLAuthProvider) - [TwitterAuthProvider](https://firebase.google.com/docs/reference/js/v8/firebase.auth.TwitterAuthProvider) - [User](https://firebase.google.com/docs/reference/js/v8/firebase.User) - [UserInfo](https://firebase.google.com/docs/reference/js/v8/firebase.UserInfo) - [UserMetadata](https://firebase.google.com/docs/reference/js/v8/firebase.auth.UserMetadata) [](https://firebase.google.com/docs/reference/js/v8#firebasedatabase) ## [firebase.database](https://firebase.google.com/docs/reference/js/v8/firebase.database) - [DataSnapshot](https://firebase.google.com/docs/reference/js/v8/firebase.database.DataSnapshot) - [Database](https://firebase.google.com/docs/reference/js/v8/firebase.database.Database) - [OnDisconnect](https://firebase.google.com/docs/reference/js/v8/firebase.database.OnDisconnect) - [Query](https://firebase.google.com/docs/reference/js/v8/firebase.database.Query) - [Reference](https://firebase.google.com/docs/reference/js/v8/firebase.database.Reference) - [ServerValue](https://firebase.google.com/docs/reference/js/v8/firebase.database.ServerValue) - [ThenableReference](https://firebase.google.com/docs/reference/js/v8/firebase.database.ThenableReference) - [TransactionResult](https://firebase.google.com/docs/reference/js/v8/firebase.database.TransactionResult) [](https://firebase.google.com/docs/reference/js/v8#firebasefirestore) ## [firebase.firestore](https://firebase.google.com/docs/reference/js/v8/firebase.firestore) - [Blob](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.Blob) - [CollectionReference](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.CollectionReference) - [DocumentChange](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.DocumentChange) - [DocumentReference](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.DocumentReference) - [DocumentSnapshot](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.DocumentSnapshot) - [FieldPath](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.FieldPath) - [FieldValue](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.FieldValue) - [Firestore](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.Firestore) - [FirestoreDataConverter](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.FirestoreDataConverter) - [FirestoreError](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.FirestoreError) - [GeoPoint](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.GeoPoint) - [GetOptions](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.GetOptions) - [LoadBundleTask](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.LoadBundleTask) - [LoadBundleTaskProgress](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.LoadBundleTaskProgress) - [PersistenceSettings](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.PersistenceSettings) - [Query](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.Query) - [QueryDocumentSnapshot](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.QueryDocumentSnapshot) - [QuerySnapshot](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.QuerySnapshot) - [SetOptions](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.SetOptions) - [Settings](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.Settings) - [SnapshotListenOptions](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.SnapshotListenOptions) - [SnapshotMetadata](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.SnapshotMetadata) - [SnapshotOptions](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.SnapshotOptions) - [Timestamp](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.Timestamp) - [Transaction](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.Transaction) - [WriteBatch](https://firebase.google.com/docs/reference/js/v8/firebase.firestore.WriteBatch) [](https://firebase.google.com/docs/reference/js/v8#firebasefunctions) ## [firebase.functions](https://firebase.google.com/docs/reference/js/v8/firebase.functions) - [Functions](https://firebase.google.com/docs/reference/js/v8/firebase.functions.Functions) - [HttpsCallable](https://firebase.google.com/docs/reference/js/v8/firebase.functions.HttpsCallable) - [HttpsCallableOptions](https://firebase.google.com/docs/reference/js/v8/firebase.functions.HttpsCallableOptions) - [HttpsCallableResult](https://firebase.google.com/docs/reference/js/v8/firebase.functions.HttpsCallableResult) - [HttpsError](https://firebase.google.com/docs/reference/js/v8/firebase.functions.HttpsError) [](https://firebase.google.com/docs/reference/js/v8#firebaseinstallations) ## [firebase.installations](https://firebase.google.com/docs/reference/js/v8/firebase.installations) - [Installations](https://firebase.google.com/docs/reference/js/v8/firebase.installations.Installations) [](https://firebase.google.com/docs/reference/js/v8#firebasemessaging) ## [firebase.messaging](https://firebase.google.com/docs/reference/js/v8/firebase.messaging) - [Messaging](https://firebase.google.com/docs/reference/js/v8/firebase.messaging.Messaging) - [FcmOptions](https://firebase.google.com/docs/reference/js/v8/firebase.messaging.FcmOptions) - [MessagePayload](https://firebase.google.com/docs/reference/js/v8/firebase.messaging.MessagePayload) - [NotificationPayload](https://firebase.google.com/docs/reference/js/v8/firebase.messaging.NotificationPayload) [](https://firebase.google.com/docs/reference/js/v8#firebaseperformance) ## [firebase.performance](https://firebase.google.com/docs/reference/js/v8/firebase.performance) - [Performance](https://firebase.google.com/docs/reference/js/v8/firebase.performance.Performance) - [Trace](https://firebase.google.com/docs/reference/js/v8/firebase.performance.Trace) [](https://firebase.google.com/docs/reference/js/v8#firebaseremoteconfig) ## [firebase.remoteconfig](https://firebase.google.com/docs/reference/js/v8/firebase.remoteconfig) - [RemoteConfig](https://firebase.google.com/docs/reference/js/v8/firebase.remoteconfig.RemoteConfig) - [Settings](https://firebase.google.com/docs/reference/js/v8/firebase.remoteconfig.Settings) - [Value](https://firebase.google.com/docs/reference/js/v8/firebase.remoteconfig.Value) [](https://firebase.google.com/docs/reference/js/v8#firebasestorage) ## [firebase.storage](https://firebase.google.com/docs/reference/js/v8/firebase.storage) - [FirebaseStorageError](https://firebase.google.com/docs/reference/js/v8/firebase.storage.FirebaseStorageError) - [FullMetadata](https://firebase.google.com/docs/reference/js/v8/firebase.storage.FullMetadata) - [ListOptions](https://firebase.google.com/docs/reference/js/v8/firebase.storage.ListOptions) - [ListResult](https://firebase.google.com/docs/reference/js/v8/firebase.storage.ListResult) - [Reference](https://firebase.google.com/docs/reference/js/v8/firebase.storage.Reference) - [SettableMetadata](https://firebase.google.com/docs/reference/js/v8/firebase.storage.SettableMetadata) - [Storage](https://firebase.google.com/docs/reference/js/v8/firebase.storage.Storage) - [StorageErrorCode](https://firebase.google.com/docs/reference/js/v8/firebase.storage.StorageErrorCode) - [StorageObserver](https://firebase.google.com/docs/reference/js/v8/firebase.storage.StorageObserver) - [UploadMetadata](https://firebase.google.com/docs/reference/js/v8/firebase.storage.UploadMetadata) - [UploadTask](https://firebase.google.com/docs/reference/js/v8/firebase.storage.UploadTask) - [UploadTaskSnapshot](https://firebase.google.com/docs/reference/js/v8/firebase.storage.UploadTaskSnapshot)