firebase-js-sdk/scripts/docgen-compat/content-sources/js/toc.yaml

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

toc:
- title: "firebase"
  path: /docs/reference/js/v8/firebase
  section:
  - title: "FirebaseError"
    path: /docs/reference/js/v8/firebase.FirebaseError
  - title: "FirebaseIdToken"
    path: /docs/reference/js/v8/firebase.FirebaseIdToken

- title: "firebase.app"
  path: /docs/reference/js/v8/firebase.app
  section:
  - title: "App"
    path: /docs/reference/js/v8/firebase.app.App

- title: "firebase.appcheck"
  path: /docs/reference/js/v8/firebase.appcheck
  section:
  - title: "AppCheck"
    path: /docs/reference/js/v8/firebase.appcheck.AppCheck
  - title: "AppCheckProvider"
    path: /docs/reference/js/v8/firebase.appcheck.AppCheckProvider
  - title: "AppCheckToken"
    path: /docs/reference/js/v8/firebase.appcheck.AppCheckToken
  - title: "AppCheckTokenResult"
    path: /docs/reference/js/v8/firebase.appcheck.AppCheckTokenResult
  - title: "CustomProvider"
    path: /docs/reference/js/v8/firebase.appcheck.CustomProvider
  - title: "CustomProviderOptions"
    path: /docs/reference/js/v8/firebase.appcheck.CustomProviderOptions
  - title: "ReCaptchaEnterpriseProvider"
    path: /docs/reference/js/v8/firebase.appcheck.ReCaptchaEnterpriseProvider
  - title: "ReCaptchaV3Provider"
    path: /docs/reference/js/v8/firebase.appcheck.ReCaptchaV3Provider

- title: "firebase.analytics"
  path: /docs/reference/js/v8/firebase.analytics
  section:
  - title: "Analytics"
    path: /docs/reference/js/v8/firebase.analytics.Analytics
  - title: "AnalyticsCallOptions"
    path: /docs/reference/js/v8/firebase.analytics.AnalyticsCallOptions
  - title: "SettingsOptions"
    path: /docs/reference/js/v8/firebase.analytics.SettingsOptions
  - title: "EventName"
    path: /docs/reference/js/v8/firebase.analytics.EventName
  - title: "ControlParams"
    path: /docs/reference/js/v8/firebase.analytics.ControlParams
  - title: "CustomParams"
    path: /docs/reference/js/v8/firebase.analytics.CustomParams
  - title: "EventParams"
    path: /docs/reference/js/v8/firebase.analytics.EventParams
  - title: "Item"
    path: /docs/reference/js/v8/firebase.analytics.Item
  - title: "Promotion"
    path: /docs/reference/js/v8/firebase.analytics.Promotion

- title: "firebase.auth"
  path: /docs/reference/js/v8/firebase.auth
  section:
  - title: "Auth"
    path: /docs/reference/js/v8/firebase.auth.Auth
  - title: "ActionCodeInfo"
    path: /docs/reference/js/v8/firebase.auth.ActionCodeInfo
  - title: "ActionCodeURL"
    path: /docs/reference/js/v8/firebase.auth.ActionCodeURL
  - title: "ApplicationVerifier"
    path: /docs/reference/js/v8/firebase.auth.ApplicationVerifier
  - title: "AuthCredential"
    path: /docs/reference/js/v8/firebase.auth.AuthCredential
  - title: "AuthError"
    path: /docs/reference/js/v8/firebase.auth.AuthError
  - title: "AuthProvider"
    path: /docs/reference/js/v8/firebase.auth.AuthProvider
  - title: "AuthSettings"
    path: /docs/reference/js/v8/firebase.auth.AuthSettings
  - title: "Config"
    path: /docs/reference/js/v8/firebase.auth.Config
  - title: "ConfirmationResult"
    path: /docs/reference/js/v8/firebase.auth.ConfirmationResult
  - title: "EmailAuthProvider"
    path: /docs/reference/js/v8/firebase.auth.EmailAuthProvider
  - title: "EmulatorConfig"
    path: /docs/reference/js/v8/firebase.auth.EmulatorConfig
  - title: "Error"
    path: /docs/reference/js/v8/firebase.auth.Error
  - title: "FacebookAuthProvider"
    path: /docs/reference/js/v8/firebase.auth.FacebookAuthProvider
  - title: "GithubAuthProvider"
    path: /docs/reference/js/v8/firebase.auth.GithubAuthProvider
  - title: "GoogleAuthProvider"
    path: /docs/reference/js/v8/firebase.auth.GoogleAuthProvider
  - title: "IdTokenResult"
    path: /docs/reference/js/v8/firebase.auth.IDTokenResult
  - title: "MultiFactorAssertion"
    path: /docs/reference/js/v8/firebase.auth.MultiFactorAssertion
  - title: "MultiFactorError"
    path: /docs/reference/js/v8/firebase.auth.MultiFactorError
  - title: "MultiFactorInfo"
    path: /docs/reference/js/v8/firebase.auth.MultiFactorInfo
  - title: "MultiFactorResolver"
    path: /docs/reference/js/v8/firebase.auth.MultiFactorResolver
  - title: "MultiFactorSession"
    path: /docs/reference/js/v8/firebase.auth.MultiFactorSession
  - title: "PhoneAuthCredential"
    path: /docs/reference/js/v8/firebase.auth.PhoneAuthCredential
  - title: "PhoneMultiFactorAssertion"
    path: /docs/reference/js/v8/firebase.auth.PhoneMultiFactorAssertion
  - title: "PhoneMultiFactorEnrollInfoOptions"
    path: /docs/reference/js/v8/firebase.auth.PhoneMultiFactorEnrollInfoOptions
  - title: "PhoneMultiFactorGenerator"
    path: /docs/reference/js/v8/firebase.auth.PhoneMultiFactorGenerator
  - title: "PhoneMultiFactorInfo"
    path: /docs/reference/js/v8/firebase.auth.PhoneMultiFactorInfo
  - title: "PhoneMultiFactorSignInInfoOptions"
    path: /docs/reference/js/v8/firebase.auth.PhoneMultiFactorSignInInfoOptions
  - title: "PhoneSingleFactorInfoOptions"
    path: /docs/reference/js/v8/firebase.auth.PhoneSingleFactorInfoOptions
  - title: "MultiFactorUser"
    path: /docs/reference/js/v8/firebase.user.MultiFactorUser
  - title: "OAuthCredential"
    path: /docs/reference/js/v8/firebase.auth.OAuthCredential
  - title: "OAuthCredentialOptions"
    path: /docs/reference/js/v8/firebase.auth.OAuthCredentialOptions
  - title: "OAuthProvider"
    path: /docs/reference/js/v8/firebase.auth.OAuthProvider
  - title: "PhoneAuthProvider"
    path: /docs/reference/js/v8/firebase.auth.PhoneAuthProvider
  - title: "RecaptchaVerifier"
    path: /docs/reference/js/v8/firebase.auth.RecaptchaVerifier
  - title: "SAMLAuthProvider"
    path: /docs/reference/js/v8/firebase.auth.SAMLAuthProvider
  - title: "TwitterAuthProvider"
    path: /docs/reference/js/v8/firebase.auth.TwitterAuthProvider
  - title: "User"
    path: /docs/reference/js/v8/firebase.User
  - title: "UserInfo"
    path: /docs/reference/js/v8/firebase.UserInfo
  - title: "UserMetadata"
    path: /docs/reference/js/v8/firebase.auth.UserMetadata

- title: "firebase.database"
  path: /docs/reference/js/v8/firebase.database
  section:
  - title: "DataSnapshot"
    path: /docs/reference/js/v8/firebase.database.DataSnapshot
  - title: "Database"
    path: /docs/reference/js/v8/firebase.database.Database
  - title: "IteratedDataSnapshot"
    path: /docs/reference/js/v8/firebase.database.IteratedDataSnapshot
  - title: "OnDisconnect"
    path: /docs/reference/js/v8/firebase.database.OnDisconnect
  - title: "Query"
    path: /docs/reference/js/v8/firebase.database.Query
  - title: "Reference"
    path: /docs/reference/js/v8/firebase.database.Reference
  - title: "ServerValue"
    path: /docs/reference/js/v8/firebase.database.ServerValue
  - title: "ThenableReference"
    path: /docs/reference/js/v8/firebase.database.ThenableReference
  - title: "TransactionResult"
    path: /docs/reference/js/v8/firebase.database.TransactionResult

- title: "firebase.firestore"
  path: /docs/reference/js/v8/firebase.firestore
  section:
  - title: "Blob"
    path: /docs/reference/js/v8/firebase.firestore.Blob
  - title: "CollectionReference"
    path: /docs/reference/js/v8/firebase.firestore.CollectionReference
  - title: "DocumentChange"
    path: /docs/reference/js/v8/firebase.firestore.DocumentChange
  - title: "DocumentReference"
    path: /docs/reference/js/v8/firebase.firestore.DocumentReference
  - title: "DocumentSnapshot"
    path: /docs/reference/js/v8/firebase.firestore.DocumentSnapshot
  - title: "FieldPath"
    path: /docs/reference/js/v8/firebase.firestore.FieldPath
  - title: "FieldValue"
    path: /docs/reference/js/v8/firebase.firestore.FieldValue
  - title: "Firestore"
    path: /docs/reference/js/v8/firebase.firestore.Firestore
  - title: "FirestoreDataConverter"
    path: /docs/reference/js/v8/firebase.firestore.FirestoreDataConverter
  - title: "FirestoreError"
    path: /docs/reference/js/v8/firebase.firestore.FirestoreError
  - title: "GeoPoint"
    path: /docs/reference/js/v8/firebase.firestore.GeoPoint
  - title: "GetOptions"
    path: /docs/reference/js/v8/firebase.firestore.GetOptions
  - title: "LoadBundleTask"
    path: /docs/reference/js/v8/firebase.firestore.LoadBundleTask
  - title: "LoadBundleTaskProgress"
    path: /docs/reference/js/v8/firebase.firestore.LoadBundleTaskProgress
  - title: "PersistenceSettings"
    path: /docs/reference/js/v8/firebase.firestore.PersistenceSettings
  - title: "Query"
    path: /docs/reference/js/v8/firebase.firestore.Query
  - title: "QueryDocumentSnapshot"
    path: /docs/reference/js/v8/firebase.firestore.QueryDocumentSnapshot
  - title: "QuerySnapshot"
    path: /docs/reference/js/v8/firebase.firestore.QuerySnapshot
  - title: "SetOptions"
    path: /docs/reference/js/v8/firebase.firestore.SetOptions
  - title: "Settings"
    path: /docs/reference/js/v8/firebase.firestore.Settings
  - title: "SnapshotListenOptions"
    path: /docs/reference/js/v8/firebase.firestore.SnapshotListenOptions
  - title: "SnapshotMetadata"
    path: /docs/reference/js/v8/firebase.firestore.SnapshotMetadata
  - title: "SnapshotOptions"
    path: /docs/reference/js/v8/firebase.firestore.SnapshotOptions
  - title: "Timestamp"
    path: /docs/reference/js/v8/firebase.firestore.Timestamp
  - title: "Transaction"
    path: /docs/reference/js/v8/firebase.firestore.Transaction
  - title: "WriteBatch"
    path: /docs/reference/js/v8/firebase.firestore.WriteBatch

- title: "firebase.functions"
  path: /docs/reference/js/v8/firebase.functions
  section:
  - title: "Functions"
    path: /docs/reference/js/v8/firebase.functions.Functions
  - title: "HttpsCallable"
    path: /docs/reference/js/v8/firebase.functions.HttpsCallable
  - title: "HttpsCallableOptions"
    path: /docs/reference/js/v8/firebase.functions.HttpsCallableOptions
  - title: "HttpsCallableResult"
    path: /docs/reference/js/v8/firebase.functions.HttpsCallableResult
  - title: "HttpsError"
    path: /docs/reference/js/v8/firebase.functions.HttpsError

- title: "firebase.installations"
  path: /docs/reference/js/v8/firebase.installations
  section:
  - title: "Installations"
    path: /docs/reference/js/v8/firebase.installations.Installations

- title: "firebase.messaging"
  path: /docs/reference/js/v8/firebase.messaging
  section:
  - title: "Messaging"
    path: /docs/reference/js/v8/firebase.messaging.Messaging
  - title: "FcmOptions"
    path: /docs/reference/js/v8/firebase.messaging.FcmOptions
  - title: "MessagePayload"
    path: /docs/reference/js/v8/firebase.messaging.MessagePayload
  - title: "NotificationPayload"
    path: /docs/reference/js/v8/firebase.messaging.NotificationPayload

- title: "firebase.performance"
  path: /docs/reference/js/v8/firebase.performance
  section:
  - title: "Performance"
    path: /docs/reference/js/v8/firebase.performance.Performance
  - title: "Trace"
    path: /docs/reference/js/v8/firebase.performance.Trace

- title: "firebase.remoteconfig"
  path: /docs/reference/js/v8/firebase.remoteconfig
  section:
  - title: "RemoteConfig"
    path: /docs/reference/js/v8/firebase.remoteconfig.RemoteConfig
  - title: "Settings"
    path: /docs/reference/js/v8/firebase.remoteconfig.Settings
  - title: "Value"
    path: /docs/reference/js/v8/firebase.remoteconfig.Value

- title: "firebase.storage"
  path: /docs/reference/js/v8/firebase.storage
  section:
  - title: "FirebaseStorageError"
    path: /docs/reference/js/v8/firebase.storage.FirebaseStorageError
  - title: "FullMetadata"
    path: /docs/reference/js/v8/firebase.storage.FullMetadata
  - title: "ListOptions"
    path: /docs/reference/js/v8/firebase.storage.ListOptions
  - title: "ListResult"
    path: /docs/reference/js/v8/firebase.storage.ListResult
  - title: "Reference"
    path: /docs/reference/js/v8/firebase.storage.Reference
  - title: "SettableMetadata"
    path: /docs/reference/js/v8/firebase.storage.SettableMetadata
  - title: "Storage"
    path: /docs/reference/js/v8/firebase.storage.Storage
  - title: "StorageErrorCode"
    path: /docs/reference/js/v8/firebase.storage.StorageErrorCode
  - title: "StorageObserver"
    path: /docs/reference/js/v8/firebase.storage.StorageObserver
  - title: "UploadMetadata"
    path: /docs/reference/js/v8/firebase.storage.UploadMetadata
  - title: "UploadTask"
    path: /docs/reference/js/v8/firebase.storage.UploadTask
  - title: "UploadTaskSnapshot"
    path: /docs/reference/js/v8/firebase.storage.UploadTaskSnapshot