From c7a02a1658343ab00c77fc4266fd3163e745abc2 Mon Sep 17 00:00:00 2001
From: Salakar <mike.diarmid@gmail.com>
Date: Fri, 3 Apr 2020 14:12:50 +0100
Subject: [PATCH] chore(docs): prettier & gen new typedocs

---
 docs/admob/displaying-ads.md                  |  32 +---
 docs/admob/european-user-consent.md           |  13 +-
 docs/admob/usage/index.md                     |   2 +-
 docs/analytics/usage/index.md                 |   4 +-
 docs/app/utils.md                             |   6 +-
 docs/auth/phone-auth.md                       |  11 +-
 docs/auth/social-auth.md                      |  34 ++--
 docs/auth/usage/index.md                      |  46 ++---
 docs/contributing.md                          |   8 +-
 docs/crashlytics/android-setup.md             |   8 +-
 docs/crashlytics/crash-reports.md             |  10 +-
 docs/crashlytics/usage/index.md               |  16 +-
 docs/database/offline-support.md              |  24 +--
 docs/database/presence-detection.md           |  16 +-
 docs/database/usage/index.md                  |  73 ++++----
 docs/dynamic-links/usage/index.md             |  17 +-
 docs/firestore/enabling-multidex.md           |   6 +-
 docs/firestore/usage-with-flatlists.md        |  42 +++--
 docs/firestore/usage/index.md                 | 168 ++++++++++--------
 docs/firestore/usage/installation/android.md  |   4 +-
 docs/functions/usage/index.md                 |  14 +-
 docs/functions/writing-deploying-functions.md |  23 ++-
 docs/iid/usage/index.md                       |   6 +-
 docs/in-app-messaging/usage/index.md          |  24 +--
 docs/index.md                                 |  16 +-
 docs/messaging/ios-permissions.md             |  18 +-
 docs/messaging/notifications.md               |  18 +-
 docs/messaging/server-integration.md          |  35 ++--
 docs/messaging/usage/index.md                 |  56 +++---
 docs/messaging/usage/installation/android.md  |   3 +-
 docs/ml-natural-language/usage/index.md       |  27 +--
 docs/ml-vision/barcode-scanning.md            |  13 +-
 docs/ml-vision/face-detection.md              |  17 +-
 docs/ml-vision/image-labelling.md             |  21 +--
 docs/ml-vision/landmark-recognition.md        |   9 +-
 docs/ml-vision/text-recognition.md            |  16 +-
 docs/ml-vision/usage/index.md                 |  20 +--
 docs/perf/axios-integration.md                |   2 +-
 docs/perf/usage/index.md                      |  30 ++--
 docs/perf/usage/installation/android.md       |   1 -
 docs/releases/index.md                        |   4 +-
 docs/releases/v6.0.0.md                       |   4 +-
 docs/releases/v6.4.0.md                       |   1 -
 docs/remote-config/index.md                   |   1 -
 docs/remote-config/usage/index.md             |  15 +-
 docs/storage/usage/index.md                   |  46 +++--
 docs/typedoc.json                             |   8 -
 docs/typedoc.min.json                         |   2 +-
 docs/typescript.md                            |   8 +-
 49 files changed, 492 insertions(+), 506 deletions(-)

diff --git a/docs/admob/displaying-ads.md b/docs/admob/displaying-ads.md
index 874264e8..d11f09af 100644
--- a/docs/admob/displaying-ads.md
+++ b/docs/admob/displaying-ads.md
@@ -20,9 +20,7 @@ Google AdMob dashboard under "Ad units" should be used:
 ```js
 import { InterstitialAd, TestIds } from '@react-native-firebase/admob';
 
-const adUnitId = __DEV__
-  ? TestIds.INTERSTITIAL
-  : 'ca-app-pub-xxxxxxxxxxxxx/yyyyyyyyyyyyyy';
+const adUnitId = __DEV__ ? TestIds.INTERSTITIAL : 'ca-app-pub-xxxxxxxxxxxxx/yyyyyyyyyyyyyy';
 
 const interstitial = InterstitialAd.createForAdRequest(adUnitId, {
   requestNonPersonalizedAdsOnly: true,
@@ -43,15 +41,9 @@ To listen to events, such as when the advert from the network has loaded or when
 ```jsx
 import React, { useEffect, useState } from 'react';
 import { Button } from 'react-native';
-import {
-  InterstitialAd,
-  AdEventType,
-  TestIds,
-} from '@react-native-firebase/admob';
+import { InterstitialAd, AdEventType, TestIds } from '@react-native-firebase/admob';
 
-const adUnitId = __DEV__
-  ? TestIds.INTERSTITIAL
-  : 'ca-app-pub-xxxxxxxxxxxxx/yyyyyyyyyyyyyy';
+const adUnitId = __DEV__ ? TestIds.INTERSTITIAL : 'ca-app-pub-xxxxxxxxxxxxx/yyyyyyyyyyyyyy';
 
 const interstitial = InterstitialAd.createForAdRequest(adUnitId, {
   requestNonPersonalizedAdsOnly: true,
@@ -120,9 +112,7 @@ Google AdMob dashboard under "Ad units" should be used:
 ```js
 import { RewardedAd, TestIds } from '@react-native-firebase/admob';
 
-const adUnitId = __DEV__
-  ? TestIds.INTERSTITIAL
-  : 'ca-app-pub-xxxxxxxxxxxxx/yyyyyyyyyyyyyy';
+const adUnitId = __DEV__ ? TestIds.INTERSTITIAL : 'ca-app-pub-xxxxxxxxxxxxx/yyyyyyyyyyyyyy';
 
 const rewarded = RewardedAd.createForAdRequest(adUnitId, {
   requestNonPersonalizedAdsOnly: true,
@@ -143,15 +133,9 @@ To listen to events, such as when the advert from the network has loaded or when
 ```js
 import React, { useEffect, useState } from 'react';
 import { Button } from 'react-native';
-import {
-  RewardedAd,
-  RewardedAdEventType,
-  TestIds,
-} from '@react-native-firebase/admob';
+import { RewardedAd, RewardedAdEventType, TestIds } from '@react-native-firebase/admob';
 
-const adUnitId = __DEV__
-  ? TestIds.REWARDED
-  : 'ca-app-pub-xxxxxxxxxxxxx/yyyyyyyyyyyyyy';
+const adUnitId = __DEV__ ? TestIds.REWARDED : 'ca-app-pub-xxxxxxxxxxxxx/yyyyyyyyyyyyyy';
 
 const rewarded = RewardedAd.createForAdRequest(adUnitId, {
   requestNonPersonalizedAdsOnly: true,
@@ -224,9 +208,7 @@ a banner:
 import React from 'react';
 import { BannerAd, BannerAdSize, TestIds } from '@react-native-firebase/admob';
 
-const adUnitId = __DEV__
-  ? TestIds.BANNER
-  : 'ca-app-pub-xxxxxxxxxxxxx/yyyyyyyyyyyyyy';
+const adUnitId = __DEV__ ? TestIds.BANNER : 'ca-app-pub-xxxxxxxxxxxxx/yyyyyyyyyyyyyy';
 
 function App() {
   return (
diff --git a/docs/admob/european-user-consent.md b/docs/admob/european-user-consent.md
index 91900e3a..8d3311f6 100644
--- a/docs/admob/european-user-consent.md
+++ b/docs/admob/european-user-consent.md
@@ -76,9 +76,7 @@ To request consent, call the method as early as possible within your app before
 ```js
 import { AdsConsent } from '@react-native-firebase/admob';
 
-const consentInfo = await AdsConsent.requestInfoUpdate([
-  'pub-6189033257628123',
-]);
+const consentInfo = await AdsConsent.requestInfoUpdate(['pub-6189033257628123']);
 ```
 
 The result of the method returns an `AdsConsentInfo` interface, which provides information about the users status and location:
@@ -130,9 +128,7 @@ You must provide a privacy policy URL.
 ```js
 import { AdsConsent, AdsConsentStatus } from '@react-native-firebase/admob';
 
-const consentInfo = await AdsConsent.requestInfoUpdate([
-  'pub-6189033257628123',
-]);
+const consentInfo = await AdsConsent.requestInfoUpdate(['pub-6189033257628123']);
 
 if (
   consentInfo.isRequestLocationInEeaOrUnknown &&
@@ -220,10 +216,7 @@ To set a debug location, use the `setDebugGeography` method. It accepts 3 values
 For example:
 
 ```js
-import {
-  AdsConsent,
-  AdsConsentDebugGeography,
-} from '@react-native-firebase/admob';
+import { AdsConsent, AdsConsentDebugGeography } from '@react-native-firebase/admob';
 
 await AdsConsent.setDebugGeography(AdsConsentDebugGeography.EEA);
 ```
diff --git a/docs/admob/usage/index.md b/docs/admob/usage/index.md
index bf3ab1d2..d6284a74 100644
--- a/docs/admob/usage/index.md
+++ b/docs/admob/usage/index.md
@@ -89,7 +89,7 @@ npx react-native run-android
 ## Configure outbound requests
 
 Before requesting ads, you must tell the AdMob network what type of content you'd wish to receive based on your target
-audience. 
+audience.
 
 For example, if the application targets children then you must configure the outbound requests to only
 receive content suitable for children before loading any adverts.
diff --git a/docs/analytics/usage/index.md b/docs/analytics/usage/index.md
index a9c32c0f..9c9c08fc 100644
--- a/docs/analytics/usage/index.md
+++ b/docs/analytics/usage/index.md
@@ -70,8 +70,8 @@ function App() {
 
 ## Pre-defined Events
 
-To help you get started, Analytics provides a number of [event methods](/reference/analytics) that are common among 
-different types of apps, including retail and ecommerce, travel, and gaming apps. To learn more about these events and 
+To help you get started, Analytics provides a number of [event methods](/reference/analytics) that are common among
+different types of apps, including retail and ecommerce, travel, and gaming apps. To learn more about these events and
 when to use them, browse the [Events and properties](https://support.google.com/analytics/answer/9322688?hl=en&ref_topic=9267641)
 articles in the Firebase Help Center.
 
diff --git a/docs/app/utils.md b/docs/app/utils.md
index 5929bca5..523d1dec 100644
--- a/docs/app/utils.md
+++ b/docs/app/utils.md
@@ -5,7 +5,7 @@ next: /crashlytics/usage
 previous: /app/usage
 ---
 
-The App module also provides access to some handy utility methods which have been exposed to aid with your 
+The App module also provides access to some handy utility methods which have been exposed to aid with your
 development.
 
 # File Paths
@@ -31,13 +31,13 @@ and screenshots—in the Firebase console.
 
 It is useful to change the apps configuration if it is being run in Test Lab, for example disabling Analytics
 data collection. Such functionality can be carried out by taking advantage of the `isRunningInTestLab`.
- 
+
 > Be aware, `isRunningInTestLab` is Android only property!
 
 ```js
 import { utils } from '@react-native-firebase/app';
 import analytics from '@react-native-firebase/analytics';
- 
+
 async function bootstrap() {
   if (utils().isRunningInTestLab) {
     await analytics().setAnalyticsCollectionEnabled(false);
diff --git a/docs/auth/phone-auth.md b/docs/auth/phone-auth.md
index 099ffdf8..2a3449e8 100644
--- a/docs/auth/phone-auth.md
+++ b/docs/auth/phone-auth.md
@@ -15,7 +15,7 @@ end-user consent prior to using the Firebase Authentication phone number sign-in
 
 > Firebase Phone Auth is not supported in all countries. Please see their [FAQs](https://firebase.google.com/support/faq/#develop) for more information.
 
-Ensure the "Phone" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers). 
+Ensure the "Phone" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers).
 
 # Sign-in
 
@@ -62,10 +62,7 @@ function PhoneSignIn() {
   return (
     <>
       <TextInput value={code} onChangeText={text => setCode(text)} />
-      <Button
-        title="Confirm Code"
-        onPress={() => confirmCode()}
-      /> 
+      <Button title="Confirm Code" onPress={() => confirmCode()} />
     </>
   );
 }
@@ -85,5 +82,5 @@ On the [Firebase Console](https://console.firebase.google.com/project/_/authenti
 
 Enter a new phone number (e.g. `+44 7444 555666`) and a test code (e.g. `123456`).
 
-Once added, the number can be used with the `signInWithPhoneNumber` method, and entering the code specified will 
-cause a successful sign-in. 
+Once added, the number can be used with the `signInWithPhoneNumber` method, and entering the code specified will
+cause a successful sign-in.
diff --git a/docs/auth/social-auth.md b/docs/auth/social-auth.md
index ce16caca..c2f169b5 100644
--- a/docs/auth/social-auth.md
+++ b/docs/auth/social-auth.md
@@ -5,7 +5,7 @@ next: /auth/phone-auth
 previous: /auth/usage
 ---
 
-React Native Firebase provides support for integrating with different social platforms. The authentication with these 
+React Native Firebase provides support for integrating with different social platforms. The authentication with these
 different platforms is left to the developer to implement due to the various implementations and flows possible using
 their oAuth APIs.
 
@@ -21,10 +21,10 @@ To integrate Apple Sign-In on your iOS applications, you need to install a 3rd p
 Once authentication is successful, a Firebase credential can be used to sign the user into Firebase with their Apple account.
 
 To get started, you must first install the [`react-native-apple-authentication`](https://github.com/invertase/react-native-apple-authentication)
-library. There are a number of [prerequisites](https://github.com/invertase/react-native-apple-authentication#prerequisites-to-using-this-library) to using the library, including 
+library. There are a number of [prerequisites](https://github.com/invertase/react-native-apple-authentication#prerequisites-to-using-this-library) to using the library, including
 [setting up your Apple Developer account](https://github.com/invertase/react-native-apple-authentication/blob/master/docs/INITIAL_SETUP.md) to enable Apple Sign-In.
 
-Ensure the "Apple" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers). 
+Ensure the "Apple" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers).
 
 Once setup, we can trigger an initial request to allow user to sign in with their Apple account, using a pre-rendered
 button the `react-native-apple-authentication` library provides:
@@ -55,8 +55,8 @@ passing in the scope required for our application:
 import auth from '@react-native-firebase/auth';
 import appleAuth, {
   AppleAuthRequestScope,
-  AppleAuthRequestOperation
-  } from '@invertase/react-native-apple-authentication';
+  AppleAuthRequestOperation,
+} from '@invertase/react-native-apple-authentication';
 
 async function onAppleButtonPress() {
   // Start the sign-in request
@@ -64,14 +64,14 @@ async function onAppleButtonPress() {
     requestedOperation: AppleAuthRequestOperation.LOGIN,
     requestedScopes: [AppleAuthRequestScope.EMAIL, AppleAuthRequestScope.FULL_NAME],
   });
- 
+
   // Ensure Apple returned a user identityToken
   if (!appleAuthRequestResponse.identityToken) {
     throw 'Apple Sign-In failed - no identify token returned';
   }
 
   // Create a Firebase credential from the response
-  const { identityToken, nonce } = appleAuthRequestResponse; 
+  const { identityToken, nonce } = appleAuthRequestResponse;
   const appleCredential = auth.AppleAuthProvider.credential(identityToken, nonce);
 
   // Sign the user in with the credential
@@ -89,9 +89,9 @@ the native Facebook SDKs to enable Facebook sign-in.
 
 Before getting started, ensure you have installed the library, [configured your Android & iOS applications](https://developers.facebook.com/docs/android/getting-started/) and
 setup your [Facebook Developer Account](https://github.com/facebook/react-native-fbsdk#3-configure-projects)
-to enable Facebook Login. 
+to enable Facebook Login.
 
-Ensure the "Facebook" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers). 
+Ensure the "Facebook" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers).
 
 Once setup, we can trigger the login flow with Facebook by calling the `logInWithPermissions` method on the `LoginManager`
 class:
@@ -123,14 +123,14 @@ async function onFacebookButtonPress() {
   if (result.isCancelled) {
     throw 'User cancelled the login process';
   }
- 
+
   // Once signed in, get the users AccesToken
   const data = await AccessToken.getCurrentAccessToken();
 
   if (!data) {
     throw 'Something went wrong obtaining access token';
   }
- 
+
   // Create a Firebase credential with the AccessToken
   const facebookCredential = auth.FacebookAuthProvider.credential(data.accessToken);
 
@@ -149,17 +149,17 @@ we can sign-in the user with Twitter and generate a credential which can be used
 
 To get started, install the library and ensure you have completed setup, following the required [prerequisites](https://github.com/GoldenOwlAsia/react-native-twitter-signin#prerequisites) list.
 
-Ensure the "Twitter" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers). 
+Ensure the "Twitter" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers).
 
 Before triggering a sign-in request, you must initialize the Twitter SDK using your accounts consumer key & secret:
 
 ```js
 import { NativeModules } from 'react-native';
 const { RNTwitterSignIn } = NativeModules;
- 
-RNTwitterSignIn
-  .init('TWITTER_CONSUMER_KEY', 'TWITTER_CONSUMER_SECRET')
-  .then(() => console.log('Twitter SDK initialized'));
+
+RNTwitterSignIn.init('TWITTER_CONSUMER_KEY', 'TWITTER_CONSUMER_SECRET').then(() =>
+  console.log('Twitter SDK initialized'),
+);
 ```
 
 Once initalized, setup your application to trigger a sign-in request with Twitter using the `login` method.
@@ -209,7 +209,7 @@ Most configuration is already setup when using Google Sign-In with Firebase, how
 SHA1 key has been configured for use with Android. You can see view how to generate the key on the [Getting Started](/)
 documentation.
 
-Ensure the "Google" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers). 
+Ensure the "Google" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers).
 
 Before triggering a sign-in request, you must initialize the Google SDK using your any required scopes and the
 `webClientId`, which can be found on the Firebase Console Settings, as "Web API Key".
diff --git a/docs/auth/usage/index.md b/docs/auth/usage/index.md
index 9c7d4974..dd3b1254 100644
--- a/docs/auth/usage/index.md
+++ b/docs/auth/usage/index.md
@@ -8,7 +8,7 @@ previous: /analytics/screen-tracking
 
 # Installation
 
-This module requires that the `@react-native-firebase/app` module is already setup and installed. To install the "app" 
+This module requires that the `@react-native-firebase/app` module is already setup and installed. To install the "app"
 module, view the [Getting Started](/) documentation.
 
 ```bash
@@ -27,12 +27,12 @@ you can follow the manual installation steps for [iOS](/auth/usage/installation/
 
 # What does it do
 
-Firebase Authentication provides backend services & easy-to-use SDKs to authenticate users to your app. It supports 
+Firebase Authentication provides backend services & easy-to-use SDKs to authenticate users to your app. It supports
 authentication using passwords, phone numbers, popular federated identity providers like Google, Facebook and Twitter, and more.
 
 <Youtube id="8sGY55yxicA" />
 
-Firebase Authentication integrates tightly with other Firebase services, and it leverages industry standards like OAuth 
+Firebase Authentication integrates tightly with other Firebase services, and it leverages industry standards like OAuth
 2.0 and OpenID Connect, so it can be easily integrated with your custom backend.
 
 # Usage
@@ -51,25 +51,25 @@ render of our main application whilst the connection is established:
 import React, { useState, useEffect } from 'react';
 import { View, Text } from 'react-native';
 import auth from '@react-native-firebase/auth';
- 
+
 function App() {
   // Set an initializing state whilst Firebase connects
   const [initializing, setInitializing] = useState(true);
   const [user, setUser] = useState();
- 
+
   // Handle user state changes
   function onAuthStateChanged(user) {
     setUser(user);
     if (initializing) setInitializing(false);
   }
- 
+
   useEffect(() => {
     const subscriber = auth().onAuthStateChanged(onAuthStateChanged);
     return subscriber; // unsubscribe on unmount
   }, []);
- 
+
   if (initializing) return null;
- 
+
   if (!user) {
     return (
       <View>
@@ -77,7 +77,7 @@ function App() {
       </View>
     );
   }
- 
+
   return (
     <View>
       <Text>Welcome {user.email}</Text>
@@ -86,15 +86,15 @@ function App() {
 }
 ```
 
-If the `user` returned within the handler is `null` we assume the user is currently signed-out, otherwise they are 
-signed-in and a [`User`](/reference/auth/user) interface is returned. 
+If the `user` returned within the handler is `null` we assume the user is currently signed-out, otherwise they are
+signed-in and a [`User`](/reference/auth/user) interface is returned.
 
 The `onAuthStateChanged` method also returns an unsubscriber function which allows us to stop listening for events whenever
 the hook is no longer in use.
 
 ## Persisting authentication state
 
-On web based applications, the Firebase Web SDK takes advantage of features such as cookies and localstorage to persist 
+On web based applications, the Firebase Web SDK takes advantage of features such as cookies and localstorage to persist
 the users authenticated state across sessions. The native Firebase SDKs also provide this functionality using device native SDKs,
 ensuring that a users previous authentication state between app sessions is persisted.
 
@@ -103,21 +103,21 @@ The user is able to clear their state by deleting the apps data/cache from the d
 ## Anonymous sign-in
 
 Some applications don't require authentication, which make it tricky to identify what users are doing throughout your app.
-If connecting with external APIs, it is also useful to add an extra layer of security by ensuring the users request is 
+If connecting with external APIs, it is also useful to add an extra layer of security by ensuring the users request is
 from the app. This can be achieved with the `signInAnonymously` method, which creates a new anonymous user which is persisted,
 allowing you to integrate with other services such as Analytics by providing a user ID.
 
-Ensure the "Anonymous" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers). 
+Ensure the "Anonymous" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers).
 
 ```js
 import auth from '@react-native-firebase/auth';
- 
+
 auth()
   .signInAnonymously()
   .then(() => {
     console.log('User signed in anonymously');
   })
-  .catch((error) => {
+  .catch(error => {
     if (error.code === 'auth/operation-not-allowed') {
       console.log('Enable anonymous in your firebase console.');
     }
@@ -134,28 +134,28 @@ to the error. For a full list of error codes available, view the [Firebase docum
 
 ## Email/Password sign-in
 
-Email/password sign in is a common method for user sign in on applications. This requires the user to provide an email 
-address and secure password. Users can both register and sign in using a method called `createUserWithEmailAndPassword` 
+Email/password sign in is a common method for user sign in on applications. This requires the user to provide an email
+address and secure password. Users can both register and sign in using a method called `createUserWithEmailAndPassword`
 or sign in to an existing account with `signInWithEmailAndPassword`.
 
-Ensure the "Email/Password" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers). 
+Ensure the "Email/Password" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/project/_/authentication/providers).
 
-The `createUserWithEmailAndPassword` performs to operations; first creating the user if they do not already exist, and 
+The `createUserWithEmailAndPassword` performs to operations; first creating the user if they do not already exist, and
 then signing them in.
 
 ```js
 import auth from '@react-native-firebase/auth';
- 
+
 auth()
   .createUserWithEmailAndPassword('sarah.lane@gmail.com', 'SuperSecretPassword!')
   .then(() => {
     console.log('User account created & signed in!');
   })
-  .catch((error) => {
+  .catch(error => {
     if (error.code === 'auth/email-already-in-use') {
       console.log('That email address is already in use!');
     }
-    
+
     if (error.code === 'auth/invalid-email') {
       console.log('That email address is invalid!');
     }
diff --git a/docs/contributing.md b/docs/contributing.md
index 882ca784..31aceb2f 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -6,12 +6,11 @@ previous: /releases
 ---
 
 Firstly, thanks for considering contributing to React Native Firebase! It's people like you that make the open source
-community such a great community!Firstly, thanks for considering contributing to React Native Firebase! It's people 
+community such a great community! Firstly, thanks for considering contributing to React Native Firebase! It's people
 like you that make the open source community such a great community!
 
 We welcome any type of contribution, not just code. You can learn more about the various ways of contributing to this
 project by visiting any of the sections below.
-                                                    
 
 # Issues & PRs
 
@@ -35,10 +34,10 @@ Here are some example review checks that can be taken on issues;
 
 # Documentation
 
-All documentation is open sourced and we are happy to accept contributions whether they are typo fixes or new pages. 
+All documentation is open sourced and we are happy to accept contributions whether they are typo fixes or new pages.
 Content is written in Markdown, and takes advantage of [MDX](https://github.com/mdx-js/mdx) to provide powerful functionality on-top of Markdown.
 
-Our documentation reference is automatically generated from each packages TypeScript declaration. Our build process 
+Our documentation reference is automatically generated from each packages TypeScript declaration. Our build process
 automatically generates a `typedoc.json` file using Typedoc, which is then parsed into a consumable format for our documentation generator.
 
 # Community
@@ -47,6 +46,7 @@ We always love to hear about React Native Firebase being featured at community e
 or attending an event which involves the library, please let us know using the form below.
 
 We'd love to help promote the event via:
+
 - Twitter exposure on our [@rnfirebase](https://twitter.com/rnfirebase) account.
 - Members of our team attending the event in person.
 - Giving out React Native Firebase T-Shirts.
diff --git a/docs/crashlytics/android-setup.md b/docs/crashlytics/android-setup.md
index 3f11588e..5116b042 100644
--- a/docs/crashlytics/android-setup.md
+++ b/docs/crashlytics/android-setup.md
@@ -8,9 +8,9 @@ description: Additional Android steps for Crashlytics integration
 # Adding Fabric Gradle Tools
 
 These steps are required, if you do not add these your app will most likely crash at startup with the following Error:
- 
+
 "The Crashlytics build ID is missing. This occurs when Crashlytics tooling is absent from your app's build configuration.
-Please review Crashlytics onboarding instructions and ensure you have a valid Crashlytics account."_
+Please review Crashlytics onboarding instructions and ensure you have a valid Crashlytics account."\_
 
 ## 1. Add the Fabric Maven repository
 
@@ -56,9 +56,9 @@ apply plugin: 'io.fabric'
 // ..
 ```
 
-## 4. (Optional) Enable Crashlytics NDK reporting 
+## 4. (Optional) Enable Crashlytics NDK reporting
 
-Crashlytics NDK reporting allows you to capture Native Development Kit crashes, e.g. in React Native this will capture 
+Crashlytics NDK reporting allows you to capture Native Development Kit crashes, e.g. in React Native this will capture
 crashes originating from the Yoga layout engine.
 
 Add the `crashlytics` block line to the `android/app/build.gradle` file:
diff --git a/docs/crashlytics/crash-reports.md b/docs/crashlytics/crash-reports.md
index 64ee1610..fdbf4acb 100644
--- a/docs/crashlytics/crash-reports.md
+++ b/docs/crashlytics/crash-reports.md
@@ -7,8 +7,8 @@ previous: /crashlytics/usage
 
 # Overview
 
-Once you have Crashlytics up and running in your app, you can navigate to Crashlytics in your Firebase Console underneath 
-'Quality' and start reviewing the reports as they come in. If this page still tells you to setup, build or run your app 
+Once you have Crashlytics up and running in your app, you can navigate to Crashlytics in your Firebase Console underneath
+'Quality' and start reviewing the reports as they come in. If this page still tells you to setup, build or run your app
 then you have not correctly setup Crashlytics in your app (see [Usage](/crashlytics/usage)).
 
 > Keep in mind when testing out Crashlytics that Crashlytics is [disabled by default in debug mode](crashlytics/usage#crashlytics-in-debug-mode).
@@ -21,9 +21,9 @@ In this example the [Crash Attributes](crashlytics/usage#crash-attributes) examp
 
 ## Issues
 
-Under issues, Firebase has gathered all the reports from your app and organised them into separate issues, where each 
+Under issues, Firebase has gathered all the reports from your app and organised them into separate issues, where each
 issue is an unique crash or stack trace in your app. One of the issues visible in the example shown originates from `CrashTest.java`,
-which is the Android module responsible for testing Crashlytics through the `crash` method, throwing an uncaught exception 
+which is the Android module responsible for testing Crashlytics through the `crash` method, throwing an uncaught exception
 to crash the app. Using this method on the same platform will always add reports to the same issue.
 
 # Managing issues
@@ -42,7 +42,7 @@ about the associated user. Under keys you can see the custom attributes that we
 ## Closing issues
 
 Note that in the top right there is a button that says 'Close'. After having addressed an issue you can close it, allowing
-you to filter it out in the overview by selecting 'Open' under 'Issue state', when clicking on the 'Filter issues' button. 
+you to filter it out in the overview by selecting 'Open' under 'Issue state', when clicking on the 'Filter issues' button.
 This is visible in the first example, where we're displaying only 3 relevant non-fatal events out of the 12 that occured.
 When the same issue re-occurs, it will automatically open again. By clicking the arrow next to the button we can mute the
 issue, preventing this from happening.
diff --git a/docs/crashlytics/usage/index.md b/docs/crashlytics/usage/index.md
index f79c6679..433b9c08 100644
--- a/docs/crashlytics/usage/index.md
+++ b/docs/crashlytics/usage/index.md
@@ -48,7 +48,7 @@ Use the `log` method throughout your app to accumulate extra context for possibl
 
 Crashlytics also supports sending JavaScript stack traces to the Firebase console. This can be used in any situation where an error occurs but is caught by your own code to recover gracefully. To send a stack trace, pass a JavaScript Error to the `recordError` method.
 
-> Crash reporting is disabled by default whilst developing. To enable this, view the [enable debug crash logs](#enable-debug-crash-logs) documentation. 
+> Crash reporting is disabled by default whilst developing. To enable this, view the [enable debug crash logs](#enable-debug-crash-logs) documentation.
 
 ## Crash Attributes
 
@@ -135,9 +135,7 @@ export default function App() {
   if (userCounts) {
     return (
       <View>
-        <Text>
-          There are currently {userCounts[userCounts.length - 1]} users.
-        </Text>
+        <Text>There are currently {userCounts[userCounts.length - 1]} users.</Text>
       </View>
     );
   }
@@ -161,9 +159,7 @@ import { View, Button } from 'react-native';
 import crashlytics from '@react-native-firebase/crashlytics';
 
 function App() {
-  const [enabled, setEnabled] = useState(
-    crashlytics().isCrashlyticsCollectionEnabled
-  );
+  const [enabled, setEnabled] = useState(crashlytics().isCrashlyticsCollectionEnabled);
 
   async function toggleCrashlytics() {
     await crashlytics()
@@ -185,7 +181,7 @@ function App() {
 
 ## Disable Auto Collection
 
-Additionally, you can configure whether Crashlytics sends out any reports through the `auto_collection_enabled` option in 
+Additionally, you can configure whether Crashlytics sends out any reports through the `auto_collection_enabled` option in
 your `firebase.json` config. If you want users to opt-in, it is recommended that you disable this here and enable it later
 through the method once they opt-in.
 
@@ -213,8 +209,8 @@ Because you have stack traces readily available while you're debugging your app,
 
 ## Crashlytics NDK
 
-React Native Firebase supports [Crashlytics NDK](https://docs.fabric.io/android/crashlytics/ndk.html#using-gradle) reporting 
-which is enabled by default. This allows Crashlytics to capture crashes originating from the Yoga layout engine used by 
+React Native Firebase supports [Crashlytics NDK](https://docs.fabric.io/android/crashlytics/ndk.html#using-gradle) reporting
+which is enabled by default. This allows Crashlytics to capture crashes originating from the Yoga layout engine used by
 React Native. You can disable Crashlytics NDK in your `firebase.json` config.
 
 ```json
diff --git a/docs/database/offline-support.md b/docs/database/offline-support.md
index 51d86df6..3f9b07cd 100644
--- a/docs/database/offline-support.md
+++ b/docs/database/offline-support.md
@@ -24,7 +24,7 @@ database()
   .then(() => console.log('Realtime Database persistence enabled'));
 
 AppRegistry.registerComponent('app', () => App);
-``` 
+```
 
 # Going offline
 
@@ -45,12 +45,12 @@ import database from '@react-native-firebase/database';
 
 function App() {
   useEffect(() => {
-    const userAgeRef = database().ref('/users/123/age')
-      
-    userAgeRef.on('value', (snapshot) => {
+    const userAgeRef = database().ref('/users/123/age');
+
+    userAgeRef.on('value', snapshot => {
       console.log('Users age: ', snapshot.val());
     });
-    
+
     database()
       .goOffline()
       .then(() => {
@@ -59,15 +59,15 @@ function App() {
       .then(() => {
         console.log('User updated whilst offline.');
       });
-  }, [])
+  }, []);
 }
 ```
 
-The above code will first execute the `on` listener with data from the remote database. 
+The above code will first execute the `on` listener with data from the remote database.
 
-Once offline, the `set` method on the reference node will `locally` be set to a new value. 
+Once offline, the `set` method on the reference node will `locally` be set to a new value.
 
-The `on` listener 
+The `on` listener
 however will now subscribe to the local database and provide the new value.
 
 This provides the ability to write code which works in both an online and offline environment without worrying about
@@ -86,10 +86,10 @@ await database().goOnline();
 
 # Local persistence size
 
-By default Firebase Database will use up to `10MB` of disk space to cache data. If the cache grows beyond this size, 
+By default Firebase Database will use up to `10MB` of disk space to cache data. If the cache grows beyond this size,
 Firebase Database will start removing data that hasn't been recently used. If you find that your application caches too
- little or too much data, call the `setPersistenceCacheSizeBytes` method to update the default cache size:
- 
+little or too much data, call the `setPersistenceCacheSizeBytes` method to update the default cache size:
+
 ```js
 import database from '@react-native-firebase/database';
 
diff --git a/docs/database/presence-detection.md b/docs/database/presence-detection.md
index c303bb18..d3dcf382 100644
--- a/docs/database/presence-detection.md
+++ b/docs/database/presence-detection.md
@@ -14,7 +14,7 @@ and you wish to view which of your users are currently online.
 
 # Setup
 
-To get started, we first need a location to store our online users. 
+To get started, we first need a location to store our online users.
 
 To keep things simple we'll assume the user is authenticated (e.g. with [Firebase Authentication](/auth)) so we can use a unique user ID.
 
@@ -32,10 +32,8 @@ function App() {
 
     const reference = database().ref(`/online/${userId}`);
 
-    // Set the /users/:userId value to true 
-    reference
-      .set(true)
-      .then(() => console.log('Online presence set'));
+    // Set the /users/:userId value to true
+    reference.set(true).then(() => console.log('Online presence set'));
   }, []);
 }
 ```
@@ -53,7 +51,7 @@ Realtime Database API provides a way to execute code on the Firebase servers whe
 is lost.
 
 The `onDisconnect` method on a reference returns a new [`OnDisconnect`](/reference/database/ondisconnect) instance. The instance
-provides functionality to remove or set data whenever a client disconnects. Using the 
+provides functionality to remove or set data whenever a client disconnects. Using the
 [`remove`](/reference/database/ondisconnect#remove) method we can remove the node on the database if the client disconnects:
 
 ```jsx
@@ -68,10 +66,8 @@ function App() {
 
     const reference = database().ref(`/online/${userId}`);
 
-    // Set the /users/:userId value to true 
-    reference
-      .set(true)
-      .then(() => console.log('Online presence set'));
+    // Set the /users/:userId value to true
+    reference.set(true).then(() => console.log('Online presence set'));
 
     // Remove the node whenever the client disconnects
     reference
diff --git a/docs/database/usage/index.md b/docs/database/usage/index.md
index a840bed2..4c381db4 100644
--- a/docs/database/usage/index.md
+++ b/docs/database/usage/index.md
@@ -27,8 +27,8 @@ you can follow the manual installation steps for [iOS](/database/usage/installat
 
 # What does it do
 
-The Realtime Database is a cloud-hosted database. Data is stored as JSON and synchronized in realtime to every connected 
-client. React Native Firebase provides native integration with the Android & iOS Firebase SDKs, supporting both realtime 
+The Realtime Database is a cloud-hosted database. Data is stored as JSON and synchronized in realtime to every connected
+client. React Native Firebase provides native integration with the Android & iOS Firebase SDKs, supporting both realtime
 data sync and offline capabilities.
 
 <Youtube id="U5aeM5dvUpA" />
@@ -55,7 +55,7 @@ const reference = database().ref('/users/123');
 The Realtime Data provides the ability to read the value of a reference as a one-time read, or realtime changes to the node.
 When a value is read from the database, the API returns a [`DataSnapshot`](/reference/database/datasnapshot).
 
-The snapshot includes information such as whether the reference node exists, it's value or any children the node has and more. 
+The snapshot includes information such as whether the reference node exists, it's value or any children the node has and more.
 
 ### One-time read
 
@@ -67,7 +67,7 @@ import database from '@react-native-firebase/database';
 database()
   .ref('/users/123')
   .once('value')
-  .then((snapshot) => {
+  .then(snapshot => {
     console.log('User data: ', snapshot.val());
   });
 ```
@@ -81,7 +81,7 @@ import database from '@react-native-firebase/database';
 
 database()
   .ref('/users/123')
-  .on('value', (snapshot) => {
+  .on('value', snapshot => {
     console.log('User data: ', snapshot.val());
   });
 ```
@@ -98,11 +98,10 @@ import database from '@react-native-firebase/database';
 
 function User({ userId }) {
   useEffect(() => {
-    const subscriber = database()
-      ref(`/users/${userId}`)
-       .on('value', (snapshot) => {
-         console.log('User data: ', snapshot.val());
-       });
+    const subscriber = database();
+    ref(`/users/${userId}`).on('value', snapshot => {
+      console.log('User data: ', snapshot.val());
+    });
 
     // Stop listening for updates when no longer required
     return () => subscriber();
@@ -116,7 +115,7 @@ The above example demonstrates how to subscribe to events whenever a value withi
 may need to only subscribe to events whenever a child node is added/changed/moved/removed. This can be achieved by passing
 a different [`EventType`](/reference/database/eventtype) to the `on` method.
 
-If you are listening to a node with many children, only listening to data you care about helps reduce network bandwidth 
+If you are listening to a node with many children, only listening to data you care about helps reduce network bandwidth
 and speeds up your application.
 
 ```jsx
@@ -125,11 +124,10 @@ import database from '@react-native-firebase/database';
 
 function User({ userId }) {
   useEffect(() => {
-    const subscriber = database()
-      ref('/users')
-       .on('child_added', (snapshot) => {
-         console.log('A new node has been added', snapshot.val());
-       });
+    const subscriber = database();
+    ref('/users').on('child_added', snapshot => {
+      console.log('A new node has been added', snapshot.val());
+    });
 
     // Stop listening for updates when no longer required
     return () => subscriber();
@@ -147,7 +145,7 @@ If your application requires more advanced query capabilities, it is recommended
 #### Ordering
 
 By default, results are ordered based on the node [keys](#database-keys). If however you are using custom keys you can use
-one of the `orederByX` methods to order your data. 
+one of the `orederByX` methods to order your data.
 
 For example, if all of the nodes children are scalar values (string, numbers or booleans) you can use the `orderByValue` method,
 and Firebase will automatically order the results. The example below would return the `def` node before the `abc` node:
@@ -160,9 +158,12 @@ and Firebase will automatically order the results. The example below would retur
  *     'def': 50,
  *   }
  * }
-*/
+ */
 
-const scores = database().ref('scores').orderByValue().once('value');
+const scores = database()
+  .ref('scores')
+  .orderByValue()
+  .once('value');
 ```
 
 #### Limiting
@@ -192,11 +193,11 @@ await database()
 ## Writing data
 
 The [Firebase documentation](https://firebase.google.com/docs/database/web/structure-data) provides great examples on best
-practices on how to structure your data. We highly recommend reading the guide before building out your database. 
+practices on how to structure your data. We highly recommend reading the guide before building out your database.
 
 ### Setting data
 
-The `set` method on a [`Reference`](/reference/database/reference) overwrites all of the existing data at that reference node. 
+The `set` method on a [`Reference`](/reference/database/reference) overwrites all of the existing data at that reference node.
 The value can be anything; a string, number, object etc:
 
 ```js
@@ -238,9 +239,10 @@ sent to remote Firebase database.
 
 The `push` method will automatically generate a new key if one is not provided:
 
-
 ```js
-const newReference = database().ref('/users').push()
+const newReference = database()
+  .ref('/users')
+  .push();
 
 console.log('Auto generated key: ', newReference.key);
 
@@ -252,20 +254,24 @@ newReference
 ```
 
 The keys generated are ordered to the current time, so the list of items returned from Firebase will be chronologically
-sorted by default. 
+sorted by default.
 
 ## Removing data
 
 To remove data, you can call the `remove` method on a reference:
 
 ```js
-await database().ref('/users/123').remove();
+await database()
+  .ref('/users/123')
+  .remove();
 ```
 
 Optionally, you can also set the value of a reference node to `null` to remove it from the database:
 
 ```js
-await database().ref('/users/123').set(null);
+await database()
+  .ref('/users/123')
+  .set(null);
 ```
 
 ## Transactions
@@ -274,7 +280,7 @@ Transactions are a away to always ensure a write occurs with the latest informat
 partially apply writes & all writes execute at the end of a successful transaction.
 
 Imagine a scenario whereby an app has the ability to "Like" user posts. Whenever a user presses the "Like" button,
-the `/likes/:postId` value (number of likes) on the database increments. Without transactions, we'd first need to 
+the `/likes/:postId` value (number of likes) on the database increments. Without transactions, we'd first need to
 read the existing value and then increment that value in two separate operations.
 
 On a high traffic application, the value on the server could already have changed by the time the operation sets a new value,
@@ -290,19 +296,18 @@ import database from '@react-native-firebase/database';
 
 function onPostLike(postId) {
   const reference = database().ref(`/likes/${postId}`);
- 
+
   // Execute transaction
-  return reference.transaction((currentLikes) => {
+  return reference.transaction(currentLikes => {
     if (currentLikes === null) return 1;
     return currentLikes + 1;
   });
 }
 
 // When post "567" is liked
-onPostLike('567')
-  .then((transaction) => {
-    console.log('New post like count: ', transaction.snapshot.val());
-  });
+onPostLike('567').then(transaction => {
+  console.log('New post like count: ', transaction.snapshot.val());
+});
 ```
 
 Once the transaction is successful, a promise is resolved with a value containing whether the operation committed on the remote
@@ -310,7 +315,7 @@ database and the new [`DataSnapshot`](/reference/database/datasnapshot) containi
 
 # Securing data
 
-It is important that you understand how to write rules in your firebase console to ensure that your data is secure. 
+It is important that you understand how to write rules in your firebase console to ensure that your data is secure.
 Please follow the firebase Realtime Database documentation on [security](https://firebase.google.com/docs/database/security)
 
 # firebase.json
diff --git a/docs/dynamic-links/usage/index.md b/docs/dynamic-links/usage/index.md
index 4dfd61f8..75821560 100644
--- a/docs/dynamic-links/usage/index.md
+++ b/docs/dynamic-links/usage/index.md
@@ -31,7 +31,7 @@ Dynamic Links are links that work the way you want, on either iOS or Android and
 
 <Youtube id="LvY1JMcrPF8" />
 
-With Dynamic Links, your users get the best available experience for the platform they open your link on. If a user opens 
+With Dynamic Links, your users get the best available experience for the platform they open your link on. If a user opens
 a Dynamic Link on iOS or Android, they can be taken directly to the linked content in your app.
 
 # Usage
@@ -98,15 +98,14 @@ the application was opened via a link:
 import dynamicLinks from '@react-native-firebase/dynamic-links';
 
 function App() {
-
   useEffect(() => {
-     dynamicLinks()
-       .getInitialLink()
-       .then((link) => {
-         if (link.url === 'https://invertase.io/offer') {
-           // ...set initial route as offers screen
-         }
-       });
+    dynamicLinks()
+      .getInitialLink()
+      .then(link => {
+        if (link.url === 'https://invertase.io/offer') {
+          // ...set initial route as offers screen
+        }
+      });
   }, []);
 
   return null;
diff --git a/docs/firestore/enabling-multidex.md b/docs/firestore/enabling-multidex.md
index 9de1fef4..0c87ace3 100644
--- a/docs/firestore/enabling-multidex.md
+++ b/docs/firestore/enabling-multidex.md
@@ -1,9 +1,9 @@
 ---
-title: Enabling Multidex 
+title: Enabling Multidex
 description: The Cloud Firestore SDK on Android can sometimes cause Dex errors, learn how to fix them.
 ---
 
-The Android Firebase Firestore SDK is a large library, and in some scenarios it may bump you over the 
+The Android Firebase Firestore SDK is a large library, and in some scenarios it may bump you over the
 65k method limit on the Android build system.
 
 If you have added Cloud Firestore as a dependency and your application build is now failing with the following error,
@@ -13,7 +13,7 @@ you'll need to [enable multidex](https://developer.android.com/studio/build/mult
 
 ## Enabling Multidex
 
-Open the `/android/app/build.gradle` file. Under `dependencies` we need to add the module, and then enable it 
+Open the `/android/app/build.gradle` file. Under `dependencies` we need to add the module, and then enable it
 within out `defaultConfig`:
 
 ```groovy
diff --git a/docs/firestore/usage-with-flatlists.md b/docs/firestore/usage-with-flatlists.md
index f8d3b0ad..2b05cee6 100644
--- a/docs/firestore/usage-with-flatlists.md
+++ b/docs/firestore/usage-with-flatlists.md
@@ -15,7 +15,7 @@ on our application.
 
 # Setup state
 
-First, setup a component which will display the list of data. The component will have 2 separate states; `loading` and 
+First, setup a component which will display the list of data. The component will have 2 separate states; `loading` and
 `users`:
 
 ```jsx
@@ -36,7 +36,7 @@ function Users() {
 
 # useEffect hook
 
-Next, we'll setup a hook with `useEffect`. This hook will trigger when our components mount, and we'll then subscribe to 
+Next, we'll setup a hook with `useEffect`. This hook will trigger when our components mount, and we'll then subscribe to
 the "Users" collection documents:
 
 ```jsx
@@ -49,9 +49,11 @@ function Users() {
   const [users, setUsers] = useState([]); // Initial empty array of users
 
   useEffect(() => {
-    const subscriber = firestore().collection('Users').onSnapshot(() => {
-      // see next step
-    });
+    const subscriber = firestore()
+      .collection('Users')
+      .onSnapshot(() => {
+        // see next step
+      });
 
     // Unsubscribe from events when no longer in use
     return () => subscriber();
@@ -73,19 +75,21 @@ we can use the `id` of a document:
 
 ```js
 useEffect(() => {
-  const subscriber = firestore().collection('Users').onSnapshot((querySnapshot) => {
-    const users = [];
- 
-    querySnapshot.forEach((documentSnapshot) => {
-      users.push({
-        ...documentSnapshot.data(),
-        key: documentSnapshot.id,
-      });
-    });
+  const subscriber = firestore()
+    .collection('Users')
+    .onSnapshot(querySnapshot => {
+      const users = [];
 
-    setUsers(users);
-    setLoading(false);
-  });
+      querySnapshot.forEach(documentSnapshot => {
+        users.push({
+          ...documentSnapshot.data(),
+          key: documentSnapshot.id,
+        });
+      });
+
+      setUsers(users);
+      setLoading(false);
+    });
 
   // Unsubscribe from events when no longer in use
   return () => subscriber();
@@ -93,7 +97,7 @@ useEffect(() => {
 ```
 
 Once the initial set of documents is returned, we update the `users` state with our raw object data and set the `loading`
-state to `false`. We can now 
+state to `false`. We can now
 
 # Integration
 
@@ -126,4 +130,4 @@ function Users() {
 ```
 
 With little effort, our list will automatically update in realtime whenever a document is added/removed/modified!
-This functionality can be further manipulated to respond to user filters via [Querying](/firestore/usage#querying) if required. 
+This functionality can be further manipulated to respond to user filters via [Querying](/firestore/usage#querying) if required.
diff --git a/docs/firestore/usage/index.md b/docs/firestore/usage/index.md
index 715e060f..71a1f83f 100644
--- a/docs/firestore/usage/index.md
+++ b/docs/firestore/usage/index.md
@@ -30,19 +30,18 @@ for your application. To learn more, read the [Enabling Multidex](/firestore/ena
 
 # What does it do
 
-Firestore is a flexible, scalable NoSQL cloud database to store and sync data. It keeps your data in sync across client 
+Firestore is a flexible, scalable NoSQL cloud database to store and sync data. It keeps your data in sync across client
 apps through realtime listeners and offers offline support so you can build responsive apps that work regardless of network
-latency or Internet connectivity. 
+latency or Internet connectivity.
 
 <Youtube id="QcsAb2RR52c" />
- 
 
 
 # Usage
 
 ## Collections & Documents
 
-Cloud Firestore stores data within "documents", which are contained within "collections", and documents can also contain 
+Cloud Firestore stores data within "documents", which are contained within "collections", and documents can also contain
 collections. For example, we could store a list of our users documents within a "Users" collection. The `collection` method
 allows us to reference a collection within our code:
 
@@ -60,7 +59,9 @@ on the collection by calling the `doc` method:
 import firestore from '@react-native-firebase/firestore';
 
 // Get user document with an ID of ABC
-const userDocument = firestore().collection('Users').doc('ABC');
+const userDocument = firestore()
+  .collection('Users')
+  .doc('ABC');
 ```
 
 The `doc` method returns a [`DocumentReference`](/reference/firestore/documentreference).
@@ -82,8 +83,13 @@ or [`DocumentReference`](/reference/firestore/documentreference):
 ```js
 import firestore from '@react-native-firebase/firestore';
 
-const users = await firestore().collection('Users').get();
-const user = await firestore().collection('Users').doc('ABC').get();
+const users = await firestore()
+  .collection('Users')
+  .get();
+const user = await firestore()
+  .collection('Users')
+  .doc('ABC')
+  .get();
 ```
 
 ### Realtime changes
@@ -102,7 +108,9 @@ function onError(error) {
   console.error(error);
 }
 
-firestore().collection('Users').onSnapshot(onResult, onError);
+firestore()
+  .collection('Users')
+  .onSnapshot(onResult, onError);
 ```
 
 The `onSnapshot` method also returns a function, allowing you to unsubscribe from events. This can be used within any
@@ -117,9 +125,9 @@ function User({ userId }) {
     const subscriber = firestore()
       .collection('Users')
       .doc(userId)
-      .onSnapshot((documentSnapshot) => {
-        console.log('User data: ', documentSnapshot.data())
-      });  
+      .onSnapshot(documentSnapshot => {
+        console.log('User data: ', documentSnapshot.data());
+      });
 
     // Stop listening for updates when no longer required
     return () => subscriber();
@@ -150,10 +158,10 @@ import firestore from '@react-native-firebase/firestore';
 firestore()
   .collection('Users')
   .get()
-  .then((querySnapshot) => {
+  .then(querySnapshot => {
     console.log('Total users: ', querySnapshot.size);
- 
-    querySnapshot.forEach((documentSnapshot) => {
+
+    querySnapshot.forEach(documentSnapshot => {
       console.log('User ID: ', documentSnapshot.id, documentSnapshot.data());
     });
   });
@@ -165,7 +173,7 @@ allows you to access specific information about a document (see below).
 #### DocumentSnapshot
 
 A [`DocumentSnapshot`](/reference/firestore/documentsnapshot) is returned from a query to a specific document, or as part
-of the documents returned via a [`QuerySnapshot`](/reference/firestore/querysnapshot). The snapshot provides the ability 
+of the documents returned via a [`QuerySnapshot`](/reference/firestore/querysnapshot). The snapshot provides the ability
 to view a documents data, metadata and whether a document actually exists.
 
 To view a documents data, call the `data` method on the snapshot:
@@ -177,12 +185,12 @@ firestore()
   .collection('Users')
   .doc('ABC')
   .get()
-  .then((documentSnapshot) => {
+  .then(documentSnapshot => {
     console.log('User exists: ', documentSnapshot.exists);
- 
+
     if (documentSnapshot.exists) {
       console.log('User data: ', documentSnapshot.data());
-    } 
+    }
   });
 ```
 
@@ -198,15 +206,15 @@ firestore()
   .collection('Users')
   .doc('ABC')
   .get()
-  .then((documentSnapshot) => getUserZipCode(documentSnapshot))
-  .then((zipCode) => {
+  .then(documentSnapshot => getUserZipCode(documentSnapshot))
+  .then(zipCode => {
     console.log('Users zip code is: ', zipCode);
   });
 ```
 
 ### Querying
 
-Cloud Firestore offers advanced capabilities for querying collections. 
+Cloud Firestore offers advanced capabilities for querying collections.
 
 #### Filtering
 
@@ -216,10 +224,12 @@ equality checks and "in" queries. For example, to filter users where their age i
 ```js
 firestore()
   .collection('Users')
-   // Filter results
+  // Filter results
   .where('age', '>=', 18)
   .get()
-  .then((querySnapshot) => { /* ... */ })
+  .then(querySnapshot => {
+    /* ... */
+  });
 ```
 
 Cloud Firestore also supports array membership queries. For example, to filter users who speak both English (en) or
@@ -228,10 +238,12 @@ French (fr), use the `in` filter:
 ```js
 firestore()
   .collection('Users')
-   // Filter results
+  // Filter results
   .where('languages', 'in', ['en', 'fr'])
   .get()
-  .then((querySnapshot) => {/* ... */})
+  .then(querySnapshot => {
+    /* ... */
+  });
 ```
 
 To learn more about all of the querying capabilities Cloud Firestore has to offer, view the
@@ -249,7 +261,9 @@ firestore()
   // Limit results
   .limit(20)
   .get()
-  .then((querySnapshot) => {/* ... */})
+  .then(querySnapshot => {
+    /* ... */
+  });
 ```
 
 The above example both filters the users by age and limits the documents returned to 20.
@@ -264,12 +278,14 @@ firestore()
   // Order results
   .orderBy('age', 'desc')
   .get()
-  .then((querySnapshot) => {/* ... */})
+  .then(querySnapshot => {
+    /* ... */
+  });
 ```
 
 The above example orders all user in the snapshot by age in descending order.
 
-#### Start/End 
+#### Start/End
 
 To start and/or end the query at a specific point within the collection, you can pass either a value to the `startAt`,
 `endAt`, `startAfter` or `endBefore` methods. You must specify an order to use pointers, for example:
@@ -281,7 +297,9 @@ firestore()
   .startAt(18)
   .endAt(30)
   .get()
-  .then((querySnapshot) => {/* ... */})
+  .then(querySnapshot => {
+    /* ... */
+  });
 ```
 
 The above query orders the users by age in descending order, but only returns users whose age is between 18 and 30.
@@ -289,14 +307,19 @@ The above query orders the users by age in descending order, but only returns us
 You can further specify a [`DocumentSnapshot`](/reference/firestore/documentsnapshot) instead of a specific value. For example:
 
 ```js
-const userDocumentSnapshot = await firestore().collection('Users').doc('DEF').get();
+const userDocumentSnapshot = await firestore()
+  .collection('Users')
+  .doc('DEF')
+  .get();
 
 firestore()
   .collection('Users')
   .orderBy('age', 'desc')
   .startAt(userDocumentSnapshot)
   .get()
-  .then((querySnapshot) => {/* ... */})
+  .then(querySnapshot => {
+    /* ... */
+  });
 ```
 
 The above query orders the users by age in descending order, however only returns documents whose order starts at the user
@@ -308,8 +331,8 @@ Cloud Firestore does not support the following types of queries:
 
 - Queries with range filters on different fields, as described in the previous section.
 - Logical OR queries. In this case, you should create a separate query for each OR condition and merge the query results in your app.
-- Queries with a `!=` clause. In this case, you should split the query into a greater-than query and a less-than query. 
-  For example, although the query clause `where("age", "!=", "30")` is not supported, you can get the same result set by 
+- Queries with a `!=` clause. In this case, you should split the query into a greater-than query and a less-than query.
+  For example, although the query clause `where("age", "!=", "30")` is not supported, you can get the same result set by
   combining two queries, one with the clause `where("age", "<", "30")` and one with the clause `where("age", ">", 30)`.
 
 ## Writing Data
@@ -337,7 +360,7 @@ firestore()
   });
 ```
 
-The `add` method adds the new document to your collection with a random unique ID. If you'd like to specify your own ID, 
+The `add` method adds the new document to your collection with a random unique ID. If you'd like to specify your own ID,
 call the `set` method on a [`DocumentReference`](/reference/firestore/documentreference) instead:
 
 ```js
@@ -362,15 +385,15 @@ if you'd like to update a document instead, use the `update` method:
 
 ```js
 import firestore from '@react-native-firebase/firestore';
- 
+
 firestore()
   .collection('Users')
   .doc('ABC')
   .update({
-   age: 31,
+    age: 31,
   })
   .then(() => {
-   console.log('User updated!');
+    console.log('User updated!');
   });
 ```
 
@@ -378,15 +401,15 @@ The method also provides support for updating deeply nested values via dot-notat
 
 ```js
 import firestore from '@react-native-firebase/firestore';
- 
+
 firestore()
   .collection('Users')
   .doc('ABC')
   .update({
-   'info.address.zipcode': 94040,
+    'info.address.zipcode': 94040,
   })
   .then(() => {
-   console.log('User updated!');
+    console.log('User updated!');
   });
 ```
 
@@ -402,8 +425,8 @@ class:
 firestore()
   .doc('users/ABC')
   .update({
-   'info.address.location': new firestore.GeoPoint(53.483959, -2.244644),
-  })
+    'info.address.location': new firestore.GeoPoint(53.483959, -2.244644),
+  });
 ```
 
 To store a [Blob](/reference/firestore/blob) (for example of a Base64 image string), provide the string to the static
@@ -413,8 +436,8 @@ To store a [Blob](/reference/firestore/blob) (for example of a Base64 image stri
 firestore()
   .doc('users/ABC')
   .update({
-   'info.avatar': firestore.Blob.fromBase64String('data:image/png;base64,iVBOR...'),
-  })
+    'info.avatar': firestore.Blob.fromBase64String('data:image/png;base64,iVBOR...'),
+  });
 ```
 
 When storing timestamps, it is recommended you use the `serverTimestamp` static method on the [`FieldValue`](/reference/firestore/fieldvalue)
@@ -426,11 +449,11 @@ firestore()
   .doc('users/ABC')
   .update({
     createdAt: firestore.FieldValue.serverTimestamp(),
-  })
+  });
 ```
 
 Cloud Firestore also allows for storing arrays. To help manage the values with an array (adding or removing) the API
-exposes an `arrayUnion` and `arrayRemove` methods on the [`FieldValue`](/reference/firestore/fieldvalue) class. 
+exposes an `arrayUnion` and `arrayRemove` methods on the [`FieldValue`](/reference/firestore/fieldvalue) class.
 
 To add a new value to an array (if it does not exist):
 
@@ -439,7 +462,7 @@ firestore()
   .doc('users/ABC')
   .update({
     fcmTokens: firestore.FieldValue.arrayUnion('ABCDE123456'),
-  })
+  });
 ```
 
 To remove a value from the array (if it exists):
@@ -449,7 +472,7 @@ firestore()
   .doc('users/ABC')
   .update({
     fcmTokens: firestore.FieldValue.arrayRemove('ABCDE123456'),
-  })
+  });
 ```
 
 ## Removing data
@@ -458,20 +481,20 @@ You can delete documents within Cloud Firestore using the `delete` method on a [
 
 ```js
 import firestore from '@react-native-firebase/firestore';
- 
+
 firestore()
   .collection('Users')
   .doc('ABC')
   .delete()
   .then(() => {
-   console.log('User deleted!');
+    console.log('User deleted!');
   });
 ```
 
-At this time, you cannot delete an entire collection without use of a Firebase Admin SDK. 
+At this time, you cannot delete an entire collection without use of a Firebase Admin SDK.
 
 > If a document contains any sub-collections, these will not be deleted from database. You must delete
-  any sub-collections yourself.
+> any sub-collections yourself.
 
 If you need to remove a specific property with a document, rather than the document itself, you can use the `delete`
 method on the [`FieldValue`](/reference/firestore/fieldvalue) class:
@@ -482,13 +505,13 @@ firestore()
   .doc('ABC')
   .update({
     fcmTokens: firestore.FieldValue.delete(),
-  })
+  });
 ```
 
 ## Transactions
 
 Transactions are a away to always ensure a write occurs with the latest information available on the server. Transactions
- never partially apply writes & all writes execute at the end of a successful transaction.
+never partially apply writes & all writes execute at the end of a successful transaction.
 
 Transactions are useful when you want to update a field's value based on its current value, or the value of some other field.
 If you simply want to write multiple documents without using the document's current state, a [batch write](#batch-write) would be more appropriate.
@@ -501,7 +524,7 @@ When using transactions, note that:
 - Transactions will fail when the client is offline.
 
 Imagine a scenario whereby an app has the ability to "Like" user posts. Whenever a user presses the "Like" button,
-a "likes" value (number of likes) on a "Posts" collection document increments. Without transactions, we'd first need to read 
+a "likes" value (number of likes) on a "Posts" collection document increments. Without transactions, we'd first need to read
 the existing value and then increment that value in two separate operations.
 
 On a high traffic application, the value on the server could already have changed by the time the operation sets a new value,
@@ -517,26 +540,25 @@ import firestore from '@react-native-firebase/firestore';
 
 function onPostLike(postId) {
   // Create a reference to the post
-  const postReference = firestore().doc(`posts/${postId}`)
+  const postReference = firestore().doc(`posts/${postId}`);
 
-  return firestore()
-    .runTransaction(async (transaction) => {
-      // Get post data first
-      const postSnapshot = await transaction.get(postReference);
+  return firestore().runTransaction(async transaction => {
+    // Get post data first
+    const postSnapshot = await transaction.get(postReference);
 
-      if (!postSnapshot.exists) {
-        throw "Post does not exist!";
-      }
+    if (!postSnapshot.exists) {
+      throw 'Post does not exist!';
+    }
 
-      await transaction.update(postReference, {
-        likes: postSnapshot.data().likes + 1,
-      });
+    await transaction.update(postReference, {
+      likes: postSnapshot.data().likes + 1,
     });
+  });
 }
 
 onPostLike('ABC')
   .then(() => console.log('Post likes incremented via a transaction'))
-  .catch((error) => console.error(error));
+  .catch(error => console.error(error));
 ```
 
 ## Batch write
@@ -553,20 +575,21 @@ import firestore from '@react-native-firebase/firestore';
 
 async function massDeleteUsers() {
   // Get all users
-  const usersQuerySnapshot = await firestore().collection('Users').get();
+  const usersQuerySnapshot = await firestore()
+    .collection('Users')
+    .get();
 
   // Create a new batch instance
   const batch = firestore().batch();
 
-  usersQuerySnapshot.forEach((documentSnapshot) => {
+  usersQuerySnapshot.forEach(documentSnapshot => {
     batch.delete(documentSnapshot.ref);
   });
 
   return batch.commit();
 }
 
-massDeleteUsers()
-  .then(() => console.log('All users deleted in a single batch operation.'));
+massDeleteUsers().then(() => console.log('All users deleted in a single batch operation.'));
 ```
 
 ## Secure your data
@@ -577,7 +600,7 @@ follow the firebase Firestore documentation on [security](https://firebase.googl
 ## Offline Capabilities
 
 Firestore provides out of the box support for offline capabilities. When reading and writing data, Firestore uses a local
-database which synchronises automatically with the server. Firestore functionality continues when users are offline, and 
+database which synchronises automatically with the server. Firestore functionality continues when users are offline, and
 automatically handles data migration to the server when they regain connectivity.
 
 This functionality is enabled by default, however it can be disabled if you need it to be disabled (e.g. on apps containing
@@ -592,4 +615,3 @@ function bootstrap() {
   });
 }
 ```
-
diff --git a/docs/firestore/usage/installation/android.md b/docs/firestore/usage/installation/android.md
index 6ad2e590..eb99a045 100644
--- a/docs/firestore/usage/installation/android.md
+++ b/docs/firestore/usage/installation/android.md
@@ -40,13 +40,13 @@ import io.invertase.firebase.firestore.ReactNativeFirebaseFirestorePackage;
 
 Add the package to the registry:
 
-```java
+````java
 protected List<ReactPackage> getPackages() {
   return Arrays.asList(
     new MainReactPackage(),
     new ReactNativeFirebaseFirestorePackage(),
 ```// ..
-```
+````
 
 In some scenarios, your Android build may fail with the `app:mergeDexDebug` error. This required that multidex is enabled
 for your application. To learn more, read the [Enabling Multidex](/firestore/enabling-multidex) documentation.
diff --git a/docs/functions/usage/index.md b/docs/functions/usage/index.md
index 84585f4b..c894cf6a 100644
--- a/docs/functions/usage/index.md
+++ b/docs/functions/usage/index.md
@@ -27,29 +27,29 @@ you can follow the manual installation steps for [iOS](/functions/usage/installa
 
 # What does it do
 
-Firebase Cloud Functions let you automatically run backend code in response to events triggered by Firebase features and 
-HTTPS requests. Your code is stored in Google's cloud and runs in a managed environment. There's no need to manage and 
+Firebase Cloud Functions let you automatically run backend code in response to events triggered by Firebase features and
+HTTPS requests. Your code is stored in Google's cloud and runs in a managed environment. There's no need to manage and
 scale your own servers.
 
 <Youtube id="vr0Gfvp5v1A" />
 
 After you write and deploy a function, Google's servers begin to manage the function immediately. You can fire the function
-directly with an HTTP request, via the Cloud Functions module, or in the case of background functions, Google's servers will listen for events and run 
+directly with an HTTP request, via the Cloud Functions module, or in the case of background functions, Google's servers will listen for events and run
 the function when it is triggered.
 
 For more information on use cases, view the [Firebase Cloud Functions](https://firebase.google.com/docs/functions/use-cases) documentation.
 
 # Usage
 
-The Cloud Functions module provides the functionality to directly trigger deployed HTTPs callable functions, without worrying 
-about security or implementing a HTTP request library. 
- 
+The Cloud Functions module provides the functionality to directly trigger deployed HTTPs callable functions, without worrying
+about security or implementing a HTTP request library.
+
 Functions deployed to Firebase have unique names, allowing you to easily identify which endpoint you wish to send a request to.
 To learn more about deploying Functions to Firebase, view the [Writing & Deploying Functions](/functions/writing-deploying-functions) documentation.
 
 ## Calling an endpoint
 
-Assuming we have a deployed a callable endpoint named `listProducts`, to call the endpoint the library exposes a 
+Assuming we have a deployed a callable endpoint named `listProducts`, to call the endpoint the library exposes a
 `httpsCallable` method. For example:
 
 ```js
diff --git a/docs/functions/writing-deploying-functions.md b/docs/functions/writing-deploying-functions.md
index ed3b1099..de092eb8 100644
--- a/docs/functions/writing-deploying-functions.md
+++ b/docs/functions/writing-deploying-functions.md
@@ -5,7 +5,7 @@ next: /messaging/usage
 previous: /functions/usage
 ---
 
-Cloud Functions are a powerful asset to a developers workflow, allowing you to build complex backend tasks with 
+Cloud Functions are a powerful asset to a developers workflow, allowing you to build complex backend tasks with
 minimal maintenance overhead. The following page outlines the steps required for writing, testing & deploying Cloud Functions to your Firebase project.
 
 # Environment Setup
@@ -22,7 +22,7 @@ Once installed, login to Firebase with the CLI. This process will automatically
 firebase login
 ```
 
-Once logged in, create a new directory on your development environment. This will be used as our working directory 
+Once logged in, create a new directory on your development environment. This will be used as our working directory
 where our Cloud Functions will be written and deployed from. Within this directory, run the following command from your
 terminal to initialize a new project structure:
 
@@ -30,7 +30,7 @@ terminal to initialize a new project structure:
 firebase init functions
 ```
 
-You will be offered two options for language support, for this tutorial select JavaScript. Allow the CLI to install 
+You will be offered two options for language support, for this tutorial select JavaScript. Allow the CLI to install
 dependencies using npm. Once complete your project structure will look like this:
 
 ```
@@ -66,7 +66,7 @@ npm install faker --save-dev
 
 Now it's time to write your first Cloud Function! Open up the generated `functions/index.js` file in your chosen editor.
 The CLI has already imported the `firebase-functions` package required to build a Cloud Function. Firebase uses
-[named exports](https://developer.mozilla.org/en-US/docs/web/javascript/reference/statements/export) to help identify 
+[named exports](https://developer.mozilla.org/en-US/docs/web/javascript/reference/statements/export) to help identify
 functions. These exports are used to build the API endpoint name which will be accessible from our React Native application.
 
 For this tutorial, we are creating a product listing API. Go ahead and create a new HTTPS callable named function called products:
@@ -112,7 +112,7 @@ exports.listProducts = functions.https.onCall((data, context) => {
 
 ## Testing functions
 
-Before deploying our functions project, we can run the `serve` command which builds a locally accessible instance of our 
+Before deploying our functions project, we can run the `serve` command which builds a locally accessible instance of our
 Cloud Functions. Run the following command from within the `functions/` directory:
 
 ```bash
@@ -134,19 +134,16 @@ curl -i -H "Accept: application/json" -H "Content-Type: application/json" -X GET
 
 ## Security
 
-By default the endpoint will be open to the public when deployed. Firebase offers an out-of-the-box solution for handling 
+By default the endpoint will be open to the public when deployed. Firebase offers an out-of-the-box solution for handling
 authentication, which integrates with the [Authentication](/auth) module. To secure out endpoint, check whether the `auth`
 property exists on the endpoint:
 
 ```js
 exports.listProducts = functions.https.onCall((data, context) => {
   if (!context.auth) {
-    throw new functions.https.HttpsError(
-      'unauthenticated',
-      'Endpoint requires authentication!',
-    );
+    throw new functions.https.HttpsError('unauthenticated', 'Endpoint requires authentication!');
   }
-  
+
   return products;
 });
 ```
@@ -175,7 +172,7 @@ exports.listProducts = functions.https.onCall((data, context) => {
   const { page = 1, limit = 10 } = data;
 
   const startAt = (page - 1) * limit;
-  const endAt = startAt + limit;  
+  const endAt = startAt + limit;
 
   return products.slice(startAt, endAt);
 });
@@ -184,7 +181,7 @@ exports.listProducts = functions.https.onCall((data, context) => {
 # Deploying Functions
 
 Once your functions are ready to be deployed, the project provides a `deploy` script which will upload all of your code
-onto the Firebase infrastructure and automatically provision production ready endpoints. Within the project, run the 
+onto the Firebase infrastructure and automatically provision production ready endpoints. Within the project, run the
 `deploy` script from the `functions` directory:
 
 ```bash
diff --git a/docs/iid/usage/index.md b/docs/iid/usage/index.md
index cb173271..d0b5f4c0 100644
--- a/docs/iid/usage/index.md
+++ b/docs/iid/usage/index.md
@@ -27,8 +27,8 @@ you can follow the manual installation steps for [iOS](/iid/usage/installation/i
 
 # What does it do
 
-Instance ID provides a simple API to generate security tokens that authorize third parties to access your apps server side 
-managed resources. 
+Instance ID provides a simple API to generate security tokens that authorize third parties to access your apps server side
+managed resources.
 
 An example of this is sending messages via Firebase Cloud Messaging.
 
@@ -47,7 +47,7 @@ async function getInstanceId() {
 }
 ```
 
-## Retrieving a token 
+## Retrieving a token
 
 Returns the token that authorizes performing actions on behalf of this application instance.
 
diff --git a/docs/in-app-messaging/usage/index.md b/docs/in-app-messaging/usage/index.md
index 6e66aa56..9a8e5703 100644
--- a/docs/in-app-messaging/usage/index.md
+++ b/docs/in-app-messaging/usage/index.md
@@ -27,9 +27,9 @@ you can follow the manual installation steps for [iOS](/in-app-messaging/usage/i
 
 # What does it do
 
-Firebase In-App Messaging helps you to engage your apps active users by sending them targeted, contextual messages that encourage 
-them to use key app features. For example, you could send an in-app message to get users to subscribe, watch a video, 
-complete a level, or buy an item. You can customize messages as cards, banners, modals, or images, and set up triggers 
+Firebase In-App Messaging helps you to engage your apps active users by sending them targeted, contextual messages that encourage
+them to use key app features. For example, you could send an in-app message to get users to subscribe, watch a video,
+complete a level, or buy an item. You can customize messages as cards, banners, modals, or images, and set up triggers
 so that they appear exactly when they'd benefit your users most.
 
 <Youtube id="5MRKpvKV2pg" />
@@ -38,27 +38,27 @@ React Native Firebase provides support for both native Android & iOS integration
 
 # Usage
 
-Most of the set up occurs on [Firebase Console](https://console.firebase.google.com/u/0/project/_/inappmessaging) in the 
+Most of the set up occurs on [Firebase Console](https://console.firebase.google.com/u/0/project/_/inappmessaging) in the
 `In-App Messaging` tab. You can create campaigns and customise elements such as Image, Banner, Modal & Cards to appear on
-pre-defined events (e.g. purchase). This involves no code for the developer to implement. Any published campaigns from the 
-Firebase Console are automatically handled and displayed on your user's device. 
+pre-defined events (e.g. purchase). This involves no code for the developer to implement. Any published campaigns from the
+Firebase Console are automatically handled and displayed on your user's device.
 
-This module provides a JavaScript API to allow greater control of the displaying of these messages. 
+This module provides a JavaScript API to allow greater control of the displaying of these messages.
 
 ## Displaying Messages
 
-The `setMessagesDisplaySuppressed` method allows you to control when messages can/cannot be displayed. Below illustrates 
+The `setMessagesDisplaySuppressed` method allows you to control when messages can/cannot be displayed. Below illustrates
 a use case for controlling the flow of messages:
 
->The suppressed state is not persisted between restarts, so ensure it is called as early as possible.
+> The suppressed state is not persisted between restarts, so ensure it is called as early as possible.
 
 ```jsx
 import inAppMessaging from '@react-native-firebase/in-app-messaging';
- 
+
 async function bootstrap() {
   await inAppMessaging().setMessagesDisplaySuppressed(true);
 }
- 
+
 async function onSetup(user) {
   await setupUser(user);
   // Allow user to receive messages now setup is complete
@@ -73,7 +73,7 @@ async function onSetup(user) {
 In App Messaging can be further configured to enable or disable automatic data collection for Firebase In-App Messaging.
 
 This is useful for opt-in-first data flows, for example when dealing with GDPR compliance. This can be overridden in JavaScript.
- This is possible by setting the below noted property on the `firebase.json` file at the root of your project directory.
+This is possible by setting the below noted property on the `firebase.json` file at the root of your project directory.
 
 ```json
 // <project-root>/firebase.json
diff --git a/docs/index.md b/docs/index.md
index 42ef5cd5..6fca675d 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -94,7 +94,7 @@ to your project.
 On the Firebase console, add a new iOS application and enter your projects details. The "iOS bundle ID" must match your
 local project bundle ID. The bundle ID can be found within the "General" tab when opening the project with XCode.
 
-Download the `GoogleService-Info.plist` file. 
+Download the `GoogleService-Info.plist` file.
 
 Using Xcode, open the projects `/ios/{projectName}.xcodeproj` file (or `/ios/{projectName}.xcworkspace` if using Pods).
 
@@ -156,7 +156,7 @@ you can follow the manual installation steps for [iOS](/install/ios) and [Androi
 
 ## Hermes Support
 
-At this time, React Native Firebase does not support the [Hermes](https://hermesengine.dev/) JavaScript engine due to 
+At this time, React Native Firebase does not support the [Hermes](https://hermesengine.dev/) JavaScript engine due to
 compatibility issues. We are actively tracking the changes to Hermes and will ensure support once both are compatible
 with each other.
 
@@ -186,15 +186,15 @@ project.ext {
         compileSdk: 28,
         buildTools: "28.0.3"
       ],
- 
+
       // Overriding Library SDK Versions
       firebase: [
         // Override Firebase SDK Version
         bom           : "21.1.0",
- 
+
         // Override Crashlytics SDK Version
         crashlytics   : "2.10.0",
- 
+
         // Override Crashlytics SDK Version
         crashlyticsNdk: "2.1.0"
       ],
@@ -212,10 +212,10 @@ Open your projects `/ios/Podfile` and add any of the globals shown below to the
 ```ruby
 # Override Firebase SDK Version
 $FirebaseSDKVersion = '6.8.1'
- 
+
 # Override Fabric SDK Version
 $FabricSDKVersion = '1.6.0'
- 
+
 # Override Crashlytics SDK Version
 $CrashlyticsSDKVersion = '3.1.0'
 ```
@@ -242,4 +242,4 @@ support, add the following global to the top of your `/ios/Podfile` file:
 
 ```ruby
 $RNFirebaseAsStaticFramework = true
-``` 
+```
diff --git a/docs/messaging/ios-permissions.md b/docs/messaging/ios-permissions.md
index abc3dace..3fdeeff6 100644
--- a/docs/messaging/ios-permissions.md
+++ b/docs/messaging/ios-permissions.md
@@ -53,14 +53,14 @@ await messaging().requestPermission({
 
 The full list of permission settings can be seen in the table below along with their default values:
 
-| Permission                  | Default | Description                                                                                                                                                                                             |
-| --------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `alert`                     | `true`  | Sets whether notifications can be displayed to the user on the device.                                                                                                                                  |
-| `announcement`              | `false` | If enabled, Siri will read the notification content out when devices are connected to AirPods.                                                                                                          |
-| `badge`                     | `true`  | Sets whether a notification dot will appear next to the app icon on the device when there are unread notifications.                                                                                      |
-| `carPlay`                   | `true`  | Sets whether notifications will appear when the device is connected to [CarPlay](https://www.apple.com/ios/carplay/).                                                                                   |
-| `provisional`               | `false` | Sets whether provisional permissions are granted. See [Provisional permission](#provisional-permission) for more information.                                                                           |
-| `sound`                     | `true`  | Sets whether a sound will be played when a notification is displayed on the device.                                                                                                                     |
+| Permission     | Default | Description                                                                                                                   |
+| -------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `alert`        | `true`  | Sets whether notifications can be displayed to the user on the device.                                                        |
+| `announcement` | `false` | If enabled, Siri will read the notification content out when devices are connected to AirPods.                                |
+| `badge`        | `true`  | Sets whether a notification dot will appear next to the app icon on the device when there are unread notifications.           |
+| `carPlay`      | `true`  | Sets whether notifications will appear when the device is connected to [CarPlay](https://www.apple.com/ios/carplay/).         |
+| `provisional`  | `false` | Sets whether provisional permissions are granted. See [Provisional permission](#provisional-permission) for more information. |
+| `sound`        | `true`  | Sets whether a sound will be played when a notification is displayed on the device.                                           |
 
 The settings provided will be stored by the device and will be visible in the iOS Settings UI for your application.
 
@@ -115,11 +115,11 @@ async function getExistingSettings() {
 
 Devices on iOS 12+ can take advantage of provisional permissions. This type of permission system allows for notification
 permission to be instantly granted without displaying a dialog. The permission allows notifications to be displayed quietly
+
 - meaning they're only visible within the device notification center.
 
 To enable provisional notifications, pass an object to the `requestPermission` method, with the `provisional` key set to `true`:
 
-
 ```js
 await messaging().requestPermission({
   provisional: true,
diff --git a/docs/messaging/notifications.md b/docs/messaging/notifications.md
index b60e3ee2..bc2e34d5 100644
--- a/docs/messaging/notifications.md
+++ b/docs/messaging/notifications.md
@@ -49,7 +49,9 @@ to send [messages from a server](/messaging/server-integration), a `notification
 
 ```js
 await admin.messaging().sendMulticast({
-  tokens: [/* ... */], // ['token_1', 'token_2', ...]
+  tokens: [
+    /* ... */
+  ], // ['token_1', 'token_2', ...]
   notification: {
     title: 'Basic Notification',
     body: 'This is a basic notification sent from the server!',
@@ -124,17 +126,23 @@ function App() {
   useEffect(() => {
     // Assume a message-notification contains a "type" property in the data payload of the screen to open
 
-    messaging().onNotificationOpenedApp((remoteMessage) => {
-      console.log('Notification caused app to open from background state:', remoteMessage.notification);
+    messaging().onNotificationOpenedApp(remoteMessage => {
+      console.log(
+        'Notification caused app to open from background state:',
+        remoteMessage.notification,
+      );
       navigation.navigate(remoteMessage.data.type);
     });
 
     // Check whether an initial notification is available
     messaging()
       .getInitialNotification()
-      .then((remoteMessage) => {
+      .then(remoteMessage => {
         if (remoteMessage) {
-          console.log('Notification caused app to open from quit state:', remoteMessage.notification);
+          console.log(
+            'Notification caused app to open from quit state:',
+            remoteMessage.notification,
+          );
           setInitialRoute(remoteMessage.data.type); // e.g. "Settings"
         }
         setLoading(false);
diff --git a/docs/messaging/server-integration.md b/docs/messaging/server-integration.md
index aa488383..ce670913 100644
--- a/docs/messaging/server-integration.md
+++ b/docs/messaging/server-integration.md
@@ -57,15 +57,14 @@ function App() {
     // Get the device token
     messaging()
       .getToken()
-      .then((token) => {
+      .then(token => {
         return saveTokenToDatabase(token);
       });
 
     // Listen to whether the token changes
-    return messaging()
-      .onTokenRefresh((token) => {
-        saveTokenToDatabase(token);
-      });
+    return messaging().onTokenRefresh(token => {
+      saveTokenToDatabase(token);
+    });
   }, []);
 }
 ```
@@ -83,7 +82,7 @@ so it's important to ensure that we store all tokens in the database.
 With the tokens stored in a secure datastore, we now have the ability to send messages via FCM to those devices.
 
 > The following example uses the Node.JS `firebase-admin` package to send messages to our devices, however any SDK (listed above)
-can be used.
+> can be used.
 
 Go ahead and setup the [`firebase-tools`](https://www.npmjs.com/package/firebase-admin) library on your server environment.
 Once setup, our script needs to perform two actions:
@@ -126,12 +125,14 @@ async function onUserPictureLiked(ownerId, userId, picture) {
         user: JSON.stringify(user),
         picture: JSON.stringify(picture),
       },
-    }, {
+    },
+    {
       // Required for background/quit data-only messages on iOS
       contentAvailable: true,
       // Required for background/quit data-only messages on Android
       priority: 'high',
-    });
+    },
+  );
 }
 ```
 
@@ -168,7 +169,7 @@ or updating UI. The possibilities are endless!
 # Send messages to topics
 
 When devices [subscribe to topics](/messaging/usage#topics), you can send messages without specifying/storing any device
-tokens. 
+tokens.
 
 Using the `firebase-admin` Admin SDK as an example, we can send a message to devices subscribed to a topic:
 
@@ -183,11 +184,13 @@ const message = {
   topic: 'weather',
 };
 
-admin.messaging().send(message)
-  .then((response) => {
+admin
+  .messaging()
+  .send(message)
+  .then(response => {
     console.log('Successfully sent message:', response);
   })
-  .catch((error) => {
+  .catch(error => {
     console.log('Error sending message:', error);
   });
 ```
@@ -214,11 +217,13 @@ const message = {
   condition: "'weather' in topics && ('news' in topics || 'traffic' in topics)",
 };
 
-admin.messaging().send(message)
-  .then((response) => {
+admin
+  .messaging()
+  .send(message)
+  .then(response => {
     console.log('Successfully sent message:', response);
   })
-  .catch((error) => {
+  .catch(error => {
     console.log('Error sending message:', error);
   });
 ```
diff --git a/docs/messaging/usage/index.md b/docs/messaging/usage/index.md
index db8fa86f..49a4182b 100644
--- a/docs/messaging/usage/index.md
+++ b/docs/messaging/usage/index.md
@@ -23,7 +23,7 @@ cd ios/ && pod install
 ```
 
 > iOS requires further configuration steps to be carried out before you can start receiving and sending
-messages through Firebase. Read the documentation on how to [setup iOS with Firebase Messagig](/messaging/usage/ios-setup).
+> messages through Firebase. Read the documentation on how to [setup iOS with Firebase Messagig](/messaging/usage/ios-setup).
 
 If you're using an older version of React Native without auto-linking support, or wish to integrate into an existing project,
 you can follow the manual installation steps for [iOS](/messaging/usage/installation/ios) and [Android](/messaging/usage/installation/android).
@@ -93,16 +93,16 @@ be used however you see fit within your application. Common use-cases for handli
 - Updating the application's UI.
 
 > To learn about how to send messages to devices from your own server setup, view the
-[Server Integration](/messaging/server-integration) documentation.
+> [Server Integration](/messaging/server-integration) documentation.
 
 Depending on the devices state, incoming messages are handled differently by the device and module. To understand these
 scenarios, it is first important to establish the various states a device can be in:
 
-| State          | Description                                                                                            |
-|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **Foreground** | When the application is open and in view.                                                                             |
+| State          | Description                                                                                                                                                                                               |
+| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Foreground** | When the application is open and in view.                                                                                                                                                                 |
 | **Background** | When the application is open, however in the background (minimised). This typically occurs when the user has pressed the "home" button on the device or has switched to another app via the app switcher. |
-| **Quit**       | When the device is locked or application is not active or running. The user can quit an app by "swiping it away" via the app switcher UI on the device.                |
+| **Quit**       | When the device is locked or application is not active or running. The user can quit an app by "swiping it away" via the app switcher UI on the device.                                                   |
 
 The user must have opened the app before messages can be received. If the user force quits the app from the device settings, it must be re-opened again before receiving messages.
 
@@ -113,14 +113,14 @@ Depending on the contents of the message, it's important to understand both how
 The device state and message contents determines which handler will be called:
 
 |                         | Foreground  | Background                                      | Quit                                            |
-|-------------------------|-------------|-------------------------------------------------|-------------------------------------------------|
+| ----------------------- | ----------- | ----------------------------------------------- | ----------------------------------------------- |
 | **Notification**        | `onMessage` | `setBackgroundMessageHandler`                   | `setBackgroundMessageHandler`                   |
 | **Notification + Data** | `onMessage` | `setBackgroundMessageHandler`                   | `setBackgroundMessageHandler`                   |
-| **Data**                | `onMessage` | `setBackgroundMessageHandler` (***see below***) | `setBackgroundMessageHandler` (***see below***) |
+| **Data**                | `onMessage` | `setBackgroundMessageHandler` (**_see below_**) | `setBackgroundMessageHandler` (**_see below_**) |
 
-* In cases where the message is data-only and the device is in the background or quit, both Android & iOS treat the message
-as low priority and will ignore it (i.e. no event will be sent). You can however increase the priority by setting the `priority` to `high` (Android) and
-`content-available` to `true` (iOS) properties on the payload.
+- In cases where the message is data-only and the device is in the background or quit, both Android & iOS treat the message
+  as low priority and will ignore it (i.e. no event will be sent). You can however increase the priority by setting the `priority` to `high` (Android) and
+  `content-available` to `true` (iOS) properties on the payload.
 
 To learn more about how to send these options in your message payload, view the Firebase documentation for your [FCM API implementation](https://firebase.google.com/docs/cloud-messaging/concept-options).
 
@@ -128,11 +128,11 @@ To learn more about how to send these options in your message payload, view the
 
 The device state and message contents can also determine whether a [Notification](/messaging/notifications) will be displayed:
 
-|                         | Foreground                  | Background             | Quit                   |
-|-------------------------|-----------------------------|------------------------|------------------------|
-| **Notification**        | Notification: &#10060;      | Notification: &#9989;  | Notification: &#9989;  |
-| **Notification + Data** | Notification: &#10060;      | Notification: &#9989;  | Notification: &#9989;  |
-| **Data**                | Notification: &#10060;      | Notification: &#10060; | Notification: &#10060; |
+|                         | Foreground             | Background             | Quit                   |
+| ----------------------- | ---------------------- | ---------------------- | ---------------------- |
+| **Notification**        | Notification: &#10060; | Notification: &#9989;  | Notification: &#9989;  |
+| **Notification + Data** | Notification: &#10060; | Notification: &#9989;  | Notification: &#9989;  |
+| **Data**                | Notification: &#10060; | Notification: &#10060; | Notification: &#10060; |
 
 ### Foreground state messages
 
@@ -149,7 +149,7 @@ import messaging from '@react-native-firebase/messaging';
 
 function App() {
   useEffect(() => {
-    const unsubscribe = messaging().onMessage(async (remoteMessage) => {
+    const unsubscribe = messaging().onMessage(async remoteMessage => {
       Alert.alert('A new FCM message arrived!', JSON.stringify(remoteMessage));
     });
 
@@ -213,12 +213,14 @@ admin.messaging().sendToDevice(
       user: JSON.stringify(user),
       picture: JSON.stringify(picture),
     },
-  }, {
-  // Required for background/quit data-only messages on iOS
-  contentAvailable: true,
-  // Required for background/quit data-only messages on Android
-  priority: 'high',
-});
+  },
+  {
+    // Required for background/quit data-only messages on iOS
+    contentAvailable: true,
+    // Required for background/quit data-only messages on Android
+    priority: 'high',
+  },
+);
 ```
 
 These options can be applied to all FCM messages. View the [Server Integration](/messaging/server-integration) documentation
@@ -269,12 +271,12 @@ devices subscribed to that topic will receive the message.
 Topics allow you to simplify FCM [server integration](/messaging/server-integration) as you do not need to keep a store of
 device tokens. There are however some things to keep in mind about topics:
 
-- Messages sent to topics should not contain sensitive or private information. Do not create a topic for a specific user 
-to subscribe to.
+- Messages sent to topics should not contain sensitive or private information. Do not create a topic for a specific user
+  to subscribe to.
 - Topic messaging supports unlimited subscriptions for each topic.
 - One app instance can be subscribed to no more than 2000 topics.
-- The frequency of new subscriptions is rate-limited per project. If you send too many subscription requests in a short 
-period of time, FCM servers will respond with a 429 RESOURCE_EXHAUSTED ("quota exceeded") response. Retry with exponential backoff.
+- The frequency of new subscriptions is rate-limited per project. If you send too many subscription requests in a short
+  period of time, FCM servers will respond with a 429 RESOURCE_EXHAUSTED ("quota exceeded") response. Retry with exponential backoff.
 - A server integration can send a single message to multiple topics at once. This however is limited to 5 topics.
 
 To learn more about how to send messages to devices subscribed to topics, view the [Send messages to topics](/messaging/server-integration#send-messages-to-topics)
diff --git a/docs/messaging/usage/installation/android.md b/docs/messaging/usage/installation/android.md
index 26fcfbdb..eb1662b9 100644
--- a/docs/messaging/usage/installation/android.md
+++ b/docs/messaging/usage/installation/android.md
@@ -34,6 +34,7 @@ dependencies {
 Import and apply the React Native Firebase module package to your `/android/app/src/main/java/**/MainApplication.java` file:
 
 ### 3.1 Import the package
+
 Add the following underneath
 `import com.facebook.react.ReactActivity;`:
 
@@ -42,6 +43,7 @@ import io.invertase.firebase.messaging.ReactNativeFirebaseMessagingPackage;
 ```
 
 ### 3.2 Add the package to the registry
+
 Add the following within the `MainActivity` class:
 
 ```java
@@ -61,4 +63,3 @@ Once the above steps have been completed, rebuild your Android project:
 ```bash
 npx react-native run-android
 ```
-
diff --git a/docs/ml-natural-language/usage/index.md b/docs/ml-natural-language/usage/index.md
index 1684cb40..13ad7de1 100644
--- a/docs/ml-natural-language/usage/index.md
+++ b/docs/ml-natural-language/usage/index.md
@@ -28,16 +28,15 @@ you can follow the manual installation steps for [iOS](/ml-natural-language/usag
 # What does it do
 
 The React Native Firebase ML Natural Language module supports [Smart Replies](https://firebase.google.com/docs/ml-kit/generate-smart-replies)
-& [Language Identification](https://firebase.google.com/docs/ml-kit/identify-languages) provided by Firebase ML kit. 
+& [Language Identification](https://firebase.google.com/docs/ml-kit/identify-languages) provided by Firebase ML kit.
 At this moment, the [Translation](https://firebase.google.com/docs/ml-kit/translation) module is not supported
 
 <Youtube id="ejrn_JHksws" />
 
-
 Smart reply can automatically generate relevant replies to messages. It helps helps your users respond to messages quickly,
 and makes it easier to reply to messages on devices with limited input capabilities.
 
-Language identification can be used to determine the language of a string of text. It can be useful when working with 
+Language identification can be used to determine the language of a string of text. It can be useful when working with
 user-provided text, which often doesn't come with any language information.
 
 # Usage
@@ -47,7 +46,7 @@ for each service and usage examples of each.
 
 ## Smart Replies
 
-The [Smart Replies](https://firebase.google.com/docs/ml-kit/generate-smart-replies) service from Firebase allows you to 
+The [Smart Replies](https://firebase.google.com/docs/ml-kit/generate-smart-replies) service from Firebase allows you to
 generate suggested replies based on a list of on-going conversation data.
 
 Before using the API, the Smart Reply model must be installed on your device. To enable installation of the model, set
@@ -77,19 +76,21 @@ Once complete, the `suggestReplies` method allows you to generate potential repl
 which may generate three responses per input as example below:
 
 ```jsx
-const replies = await firebase.naturalLanguage().suggestReplies([
-  { text: 'Hey, long time no speak!', },
-  { text: 'I know right, it has been a while..', userId: '123', isLocalUser: false },
-  { text: 'We should catchup some time!', },
-  { text: 'Definitely, how about we go for lunch this week?', userId: '123', isLocalUser: false },
-]);
+const replies = await firebase
+  .naturalLanguage()
+  .suggestReplies([
+    { text: 'Hey, long time no speak!' },
+    { text: 'I know right, it has been a while..', userId: '123', isLocalUser: false },
+    { text: 'We should catchup some time!' },
+    { text: 'Definitely, how about we go for lunch this week?', userId: '123', isLocalUser: false },
+  ]);
 
 replies.forEach(reply => {
   console.log(reply.text);
 });
 ```
 
-Each array item an is an instance of a [`TextMessage`](/reference/ml-natural-language/textmessage). At a minimum you 
+Each array item an is an instance of a [`TextMessage`](/reference/ml-natural-language/textmessage). At a minimum you
 must provide the a `text` property. To help the Machine Learning service identify various users in the conversation, you
 can set the `isLocalUser` flag to `false` if the message is from an external user, along with a unique ID.
 
@@ -98,7 +99,7 @@ property from the returned [`SuggestedReply`](/reference/ml-natural-language/sug
 
 ## Identify language
 
-The [Language Identification](https://firebase.google.com/docs/ml-kit/identify-languages) service from Firebase allows you to 
+The [Language Identification](https://firebase.google.com/docs/ml-kit/identify-languages) service from Firebase allows you to
 identify a language from any given string of text.
 
 Before using the API, the Language Identification model must be installed on your device. To enable installation of the model, set
@@ -138,7 +139,7 @@ Add any of the keys indicated below to your `firebase.json` file at the root of
 true to enable them. All models and APIs are disabled (false) by default.
 
 > If you are manually linking on iOS (e.g. not using CocoaPods) then it's up to you to manage these models and dependencies
-  yourself - firebase.json support is only for Android and iOS (via Pods).
+> yourself - firebase.json support is only for Android and iOS (via Pods).
 
 ```json
 // <project-root>/firebase.json
diff --git a/docs/ml-vision/barcode-scanning.md b/docs/ml-vision/barcode-scanning.md
index a3bbb8fe..bc8fa7de 100644
--- a/docs/ml-vision/barcode-scanning.md
+++ b/docs/ml-vision/barcode-scanning.md
@@ -5,12 +5,12 @@ next: /ml-vision/image-labelling
 previous: /ml-vision/landmark-recognition
 ---
 
-Barcode scanning can read data encoded using most standard barcode formats. Barcode scanning happens on the device, 
+Barcode scanning can read data encoded using most standard barcode formats. Barcode scanning happens on the device,
 and doesn't require a network connection. It's a convenient way to pass information from the real world to your app.
 
 The Machine Learning service is only offered on the device, and no cloud service exists.
 
-Given an image file, the Barcode Scanning service will attempt to recognise one or more barcodes, offering information 
+Given an image file, the Barcode Scanning service will attempt to recognise one or more barcodes, offering information
 such as:
 
 - The 4-point coordinates of the barcodes on the image.
@@ -54,8 +54,8 @@ import vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision
 
 async function processBarcodes(localPath) {
   const barcodes = await vision().barcodeDetectorProcessImage(localPath);
-  
-  barcodes.forEach((barcode) => {
+
+  barcodes.forEach(barcode => {
     if (barcode.valueType === VisionBarcodeValueType.CALENDAR_EVENT) {
       console.log('Barcode is a calendar event: ', barcode.calendarEvent);
     }
@@ -97,9 +97,8 @@ async function processBarcodes(localPath) {
 // Local path to file on the device
 const localFile = `${utils.FilePath.PICTURES_DIRECTORY}/barcode-document.jpg`;
 
-processBarcodes(localFile)
-  .then(() => console.log('Finished processing file.'));
+processBarcodes(localFile).then(() => console.log('Finished processing file.'));
 ```
 
-To learn about the types of information the barcode scanner can return, view the 
+To learn about the types of information the barcode scanner can return, view the
 [`VisionBarcode`](/reference/ml-vision/visionbarcode) documentation.
diff --git a/docs/ml-vision/face-detection.md b/docs/ml-vision/face-detection.md
index b6e26383..beedf739 100644
--- a/docs/ml-vision/face-detection.md
+++ b/docs/ml-vision/face-detection.md
@@ -5,13 +5,13 @@ next: /remote-config/usage
 previous: /ml-vision/face-detection
 ---
 
-Face detection can detect faces in an image, identify key facial features, and get the contours of detected faces. 
+Face detection can detect faces in an image, identify key facial features, and get the contours of detected faces.
 This provides information needed to perform tasks like embellishing selfies and portraits, or generating avatars
 from a user's photo.
 
 The Machine Learning service is only offered on the device, and no cloud service exists.
 
-Given an image file, the Face Detection service will attempt to recognise one or faces, offering information 
+Given an image file, the Face Detection service will attempt to recognise one or faces, offering information
 such as:
 
 - Face contour coordinates.
@@ -56,16 +56,16 @@ import vision, { VisionFaceContourType } from '@react-native-firebase/ml-vision'
 
 async function processFaces(localPath) {
   const faces = await vision().faceDetectorProcessImage(localPath);
-  
-  faces.forEach((face) => {
+
+  faces.forEach(face => {
     console.log('Head rotation on Y axis: ', face.headEulerAngleY);
     console.log('Head rotation on Z axis: ', face.headEulerAngleZ);
-  
+
     console.log('Left eye open probability: ', face.leftEyeOpenProbability);
     console.log('Right eye open probability: ', face.rightEyeOpenProbability);
     console.log('Smiling probability: ', face.smilingProbability);
 
-    face.faceContours.forEach((contour) => {
+    face.faceContours.forEach(contour => {
       if (contour.type === VisionFaceContourType.FACE) {
         console.log('Face outline points: ', contour.points);
       }
@@ -76,9 +76,8 @@ async function processFaces(localPath) {
 // Local path to file on the device
 const localFile = `${utils.FilePath.PICTURES_DIRECTORY}/barcode-document.jpg`;
 
-processBarcodes(localFile)
-  .then(() => console.log('Finished processing file.'));
+processBarcodes(localFile).then(() => console.log('Finished processing file.'));
 ```
 
-To learn about the types of information the face detector can return, view the 
+To learn about the types of information the face detector can return, view the
 [`VisionFace`](/reference/ml-vision/visionface) documentation.
diff --git a/docs/ml-vision/image-labelling.md b/docs/ml-vision/image-labelling.md
index d381d70d..34b0c581 100644
--- a/docs/ml-vision/image-labelling.md
+++ b/docs/ml-vision/image-labelling.md
@@ -5,10 +5,9 @@ next: /ml-vision/face-detection
 previous: /ml-vision/barcode-scanning
 ---
 
-Image labelling can recognize entities in an image without having to provide any additional contextual metadata, using 
+Image labelling can recognize entities in an image without having to provide any additional contextual metadata, using
 either an on-device API or a cloud-based API. It gets a list of the entities that were recognized: people, things, places,
-activities, and so on. 
- 
+activities, and so on.
 
 # Cloud Image Labelling
 
@@ -22,7 +21,7 @@ import vision from '@react-native-firebase/ml-vision';
 async function processImage(localPath) {
   const labels = await vision().cloudImageLabelerProcessImage(localPath);
 
-  labels.forEach((label) => {
+  labels.forEach(label => {
     console.log('Service labelled the image: ', label.text);
     console.log('Confidence in the label: ', label.confidence);
   });
@@ -31,17 +30,16 @@ async function processImage(localPath) {
 // Local path to file on the device
 const localFile = `${utils.FilePath.PICTURES_DIRECTORY}/image-document.jpg`;
 
-processImage(localFile)
-  .then(() => console.log('Finished processing file.'));
+processImage(localFile).then(() => console.log('Finished processing file.'));
 ```
 
 To learn more about the available data on a processed document, view the [`VisionImageLabel`](/reference/ml-vision/visionimagelabel)
 documentation.
 
 ## Configuration
- 
+
 By default, the service will return labels with any confidence level, which may include labels you do not care about or
-are too obvious. Set the `confidenceThreshold` key to a value between 0 & 1, where 1 represents 100% confidence. The 
+are too obvious. Set the `confidenceThreshold` key to a value between 0 & 1, where 1 represents 100% confidence. The
 cloud service will only return labels with a confidence greater than what you specified:
 
 ```js
@@ -56,7 +54,7 @@ View the [`VisionCloudImageLabelerOptions`](/reference/ml-vision/visioncloudimag
 # On-device Image Labelling
 
 Running the ML Kit service on a device requires the `ml_vision_image_label_model` and `ml_vision_label_model` to be download to the device. Although the results
-of on-device processing will be faster and more accurate, including the model in your application will increase the size 
+of on-device processing will be faster and more accurate, including the model in your application will increase the size
 of the application.
 
 ## Enable the model
@@ -95,7 +93,7 @@ import vision from '@react-native-firebase/ml-vision';
 async function processImage(localPath) {
   const labels = await vision().imageLabelerProcessImage(localPath);
 
-  labels.forEach((label) => {
+  labels.forEach(label => {
     console.log('Service labelled the image: ', label.text);
     console.log('Confidence in the label: ', label.confidence);
   });
@@ -104,6 +102,5 @@ async function processImage(localPath) {
 // Local path to file on the device
 const localFile = `${utils.FilePath.PICTURES_DIRECTORY}/image-document.jpg`;
 
-processImage(localFile)
-  .then(() => console.log('Finished processing file.'));
+processImage(localFile).then(() => console.log('Finished processing file.'));
 ```
diff --git a/docs/ml-vision/landmark-recognition.md b/docs/ml-vision/landmark-recognition.md
index 9c71b41f..b31fd236 100644
--- a/docs/ml-vision/landmark-recognition.md
+++ b/docs/ml-vision/landmark-recognition.md
@@ -10,7 +10,7 @@ with each landmark's geographic coordinates and the region of the image the land
 
 The Machine Learning service is only offered as a cloud based one, and no on-device service exists.
 
-Given an image file, the Landmark Recognition service will attempt to recognise one or more landmarks, offering information 
+Given an image file, the Landmark Recognition service will attempt to recognise one or more landmarks, offering information
 such as:
 
 - The 4-point coordinates of the landmarks on the image.
@@ -30,7 +30,7 @@ import vision from '@react-native-firebase/ml-vision';
 async function processLandmarks(localPath) {
   const landmarks = await vision().cloudLandmarkRecognizerProcessImage(localPath);
 
-  landmarks.forEach((visionLandmark) => {
+  landmarks.forEach(visionLandmark => {
     console.log('Landmark name: ', visionLandmark.landmark);
     console.log('Landmark locations: ', block.locations);
     console.log('Confidence score: ', block.confidence);
@@ -40,14 +40,13 @@ async function processLandmarks(localPath) {
 // Local path to file on the device
 const localFile = `${utils.FilePath.PICTURES_DIRECTORY}/image-file.jpg`;
 
-processLandmarks(localFile)
-  .then(() => console.log('Finished processing file.'));
+processLandmarks(localFile).then(() => console.log('Finished processing file.'));
 ```
 
 ## Configuration
 
 To help speed up requests and improve results, the `cloudLandmarkRecognizerProcessImage` method accepts an optional
-configuration object. 
+configuration object.
 
 ```js
 import vision, { VisionCloudLandmarkRecognizerModelType } from '@react-native-firebase/ml-vision';
diff --git a/docs/ml-vision/text-recognition.md b/docs/ml-vision/text-recognition.md
index 4051440f..20062a16 100644
--- a/docs/ml-vision/text-recognition.md
+++ b/docs/ml-vision/text-recognition.md
@@ -30,8 +30,8 @@ async function processDocument(localPath) {
   const processed = await vision().cloudDocumentTextRecognizerProcessImage(localPath);
 
   console.log('Found text in document: ', processed.text);
-  
-  processed.blocks.forEach((block) => {
+
+  processed.blocks.forEach(block => {
     console.log('Found block with text: ', block.text);
     console.log('Confidence in block: ', block.confidence);
     console.log('Languages found in block: ', block.recognizedLanguages);
@@ -41,8 +41,7 @@ async function processDocument(localPath) {
 // Local path to file on the device
 const localFile = `${utils.FilePath.PICTURES_DIRECTORY}/text-document.jpg`;
 
-processDocument(localFile)
-  .then(() => console.log('Finished processing file.'));
+processDocument(localFile).then(() => console.log('Finished processing file.'));
 ```
 
 To learn more about the available data on a processed document, view the [`VisionDocumentText`](/reference/ml-vision/visiondocumenttext)
@@ -68,7 +67,7 @@ View the [`VisionCloudDocumentTextRecognizerOptions`](/reference/ml-vision/visio
 # On-device Text Recognition
 
 Running the ML Kit service on a device requires the `ml_vision_ocr_model` to be download to the device. Although the results
-of on-device processing will be faster and more accurate, including the model in your application will increase the size 
+of on-device processing will be faster and more accurate, including the model in your application will increase the size
 of the application.
 
 ## Enable the model
@@ -107,8 +106,8 @@ async function processDocument(localPath) {
   const processed = await vision().textRecognizerProcessImage(localPath);
 
   console.log('Found text in document: ', processed.text);
-  
-  processed.blocks.forEach((block) => {
+
+  processed.blocks.forEach(block => {
     console.log('Found block with text: ', block.text);
     console.log('Confidence in block: ', block.confidence);
     console.log('Languages found in block: ', block.recognizedLanguages);
@@ -118,6 +117,5 @@ async function processDocument(localPath) {
 // Local path to file on the device
 const localFile = `${utils.FilePath.PICTURES_DIRECTORY}/text-document.jpg`;
 
-processDocument(localFile)
-  .then(() => console.log('Finished processing file.'));
+processDocument(localFile).then(() => console.log('Finished processing file.'));
 ```
diff --git a/docs/ml-vision/usage/index.md b/docs/ml-vision/usage/index.md
index 7844aab4..5e7722aa 100644
--- a/docs/ml-vision/usage/index.md
+++ b/docs/ml-vision/usage/index.md
@@ -40,16 +40,16 @@ Depending on the service, it is possible to perform Machine Learning on both the
 The table below outlines the current module support for each available service, and whether they are available on local device,
 cloud or both.
 
-| API                                                                                           | Cloud Model | On Device  |
-|-----------------------------------------------------------------------------------------------|-------------|------------|
-| [Text Recognition](https://firebase.google.com/docs/ml-kit/recognize-text)                    | ✅          | ✅        |
-| [Document Text Recognition](https://firebase.google.com/docs/ml-kit/recognize-text))          | ✅          |           |
-| [Face Detection](https://firebase.google.com/docs/ml-kit/detect-faces)                        |             | ✅        |
-| [Barcode Scanning](https://firebase.google.com/docs/ml-kit/read-barcodes)                     |             | ✅        |
-| [Image Labelling](https://firebase.google.com/docs/ml-kit/label-images)                       | ✅          | ✅        |
-| [Landmark Recognition](https://firebase.google.com/docs/ml-kit/recognize-landmarks)           |             | ✅        |
-| [AutoML Vision Edge](https://firebase.google.com/docs/ml-kit/automl-image-labeling)           | ❌          | ❌        |
-| [Object Detection/Tracking](https://firebase.google.com/docs/ml-kit/object-detection)         | ❌          | ❌        |
+| API                                                                                   | Cloud Model | On Device |
+| ------------------------------------------------------------------------------------- | ----------- | --------- |
+| [Text Recognition](https://firebase.google.com/docs/ml-kit/recognize-text)            | ✅          | ✅        |
+| [Document Text Recognition](https://firebase.google.com/docs/ml-kit/recognize-text))  | ✅          |           |
+| [Face Detection](https://firebase.google.com/docs/ml-kit/detect-faces)                |             | ✅        |
+| [Barcode Scanning](https://firebase.google.com/docs/ml-kit/read-barcodes)             |             | ✅        |
+| [Image Labelling](https://firebase.google.com/docs/ml-kit/label-images)               | ✅          | ✅        |
+| [Landmark Recognition](https://firebase.google.com/docs/ml-kit/recognize-landmarks)   |             | ✅        |
+| [AutoML Vision Edge](https://firebase.google.com/docs/ml-kit/automl-image-labeling)   | ❌          | ❌        |
+| [Object Detection/Tracking](https://firebase.google.com/docs/ml-kit/object-detection) | ❌          | ❌        |
 
 # Usage
 
diff --git a/docs/perf/axios-integration.md b/docs/perf/axios-integration.md
index 1d095829..70d3f781 100644
--- a/docs/perf/axios-integration.md
+++ b/docs/perf/axios-integration.md
@@ -71,7 +71,7 @@ axios.interceptors.response.use(
 
     // Ensure failed requests throw after interception
     return Promise.reject(error);
-  }
+  },
 );
 ```
 
diff --git a/docs/perf/usage/index.md b/docs/perf/usage/index.md
index 99e80987..14478114 100644
--- a/docs/perf/usage/index.md
+++ b/docs/perf/usage/index.md
@@ -27,7 +27,7 @@ you can follow the manual installation steps for [iOS](/perf/usage/installation/
 
 ## Add the Performance Monitoring Plugin
 
-On Android, you need to install the Google Performance Monitoring Plugin which enables automatic 
+On Android, you need to install the Google Performance Monitoring Plugin which enables automatic
 HTTPs network request monitoring.
 
 Add the plugin to your `/android/build.gradle` file as a dependency:
@@ -54,13 +54,13 @@ It provides a simple API to track custom trace and HTTP request metrics.
 
 <Youtube id="0EHSPFvH7vk" />
 
-Review and analyze that data in the Firebase console. Performance Monitoring helps you to understand where and when the 
+Review and analyze that data in the Firebase console. Performance Monitoring helps you to understand where and when the
 performance of your app can be improved so that you can use that information to fix performance issues.
 
-Performance Monitoring package automatically traces events and metrics which are sent to Firebase. For more information 
-on the automatic traces, please see the Firebase Performance Monitoring [documentation](https://firebase.google.com/docs/perf-mon/auto_duration-traces-metrics_ios-android). 
+Performance Monitoring package automatically traces events and metrics which are sent to Firebase. For more information
+on the automatic traces, please see the Firebase Performance Monitoring [documentation](https://firebase.google.com/docs/perf-mon/auto_duration-traces-metrics_ios-android).
 The package also allows you to performance monitor custom aspects to your application like network requests & task specific
-app code. All performance metrics are available on your Firebase [console](https://console.firebase.google.com/u/0/) performance tab. 
+app code. All performance metrics are available on your Firebase [console](https://console.firebase.google.com/u/0/) performance tab.
 
 # Usage
 
@@ -70,15 +70,15 @@ Below is how you would measure the amount of time it would take to complete a sp
 
 ```jsx
 import perf from '@react-native-firebase/perf';
- 
+
 async function customTrace() {
   // Define & start a trace
   const trace = await perf().startTrace('custom_trace');
- 
+
   // Define trace meta details
   trace.putAttribute('user', 'abcd');
   trace.putMetric('credits', 30);
- 
+
   // Stop the trace
   await trace.stop();
 }
@@ -90,29 +90,29 @@ Below illustrates you would measure the latency of a HTTP request.
 
 ```jsx
 import perf from '@react-native-firebase/perf';
- 
+
 async function getRequest(url) {
   // Define the network metric
   const metric = await perf().newHttpMetric(url, 'GET');
- 
+
   // Define meta details
   metric.putAttribute('user', 'abcd');
- 
+
   // Start the metric
   await metric.start();
- 
+
   // Perform a HTTP request and provide response information
   const response = await fetch(url);
   metric.setHttpResponseCode(response.status);
   metric.setResponseContentType(response.headers.get('Content-Type'));
   metric.setResponsePayloadSize(response.headers.get('Content-Length'));
- 
+
   // Stop the metric
   await metric.stop();
- 
+
   return response.json();
 }
- 
+
 // Call API
 getRequest('https://api.com').then(json => {
   console.log(json);
diff --git a/docs/perf/usage/installation/android.md b/docs/perf/usage/installation/android.md
index f4a0ffb7..2ce58ee8 100644
--- a/docs/perf/usage/installation/android.md
+++ b/docs/perf/usage/installation/android.md
@@ -56,4 +56,3 @@ Once the above steps have been completed, rebuild your Android project:
 ```bash
 npx react-native run-android
 ```
-
diff --git a/docs/releases/index.md b/docs/releases/index.md
index 0f5658f5..7698502f 100644
--- a/docs/releases/index.md
+++ b/docs/releases/index.md
@@ -7,8 +7,8 @@ previous: /releases
 
 Using the table below, you can find the release notes for the latest library releases.
 
-| Version |                                        |
-|---------|:--------------------------------------:|
+| Version |                                                |
+| ------- | :--------------------------------------------: |
 | v6.4.0  | [View Release Notes &raquo;](/releases/v6.4.0) |
 | v6.3.0  | [View Release Notes &raquo;](/releases/v6.3.0) |
 | v6.2.0  | [View Release Notes &raquo;](/releases/v6.2.0) |
diff --git a/docs/releases/v6.0.0.md b/docs/releases/v6.0.0.md
index 5cc66e2b..8017ad3a 100644
--- a/docs/releases/v6.0.0.md
+++ b/docs/releases/v6.0.0.md
@@ -14,8 +14,8 @@ with most modules now just 'install and go'.
 
 The new modules:
 
-| Name                                               |                                                                                            Downloads                                                                                            |                                                                Coverage                                                                 |
-| -------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: |
+| Name                                            |                                                                                            Downloads                                                                                            |                                                                Coverage                                                                 |
+| ----------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: |
 | [Analytics](/analytics)                         |           [![badge](https://img.shields.io/npm/dm/@react-native-firebase/analytics.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/analytics)           |           [![badge](https://api.rnfirebase.io/coverage/analytics/badge)](https://api.rnfirebase.io/coverage/analytics/detail)           |
 | [App](/app)                                     |                 [![badge](https://img.shields.io/npm/dm/@react-native-firebase/app.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/app)                 |                 [![badge](https://api.rnfirebase.io/coverage/app/badge)](https://api.rnfirebase.io/coverage/app/detail)                 |
 | [Cloud Functions](/functions)                   |           [![badge](https://img.shields.io/npm/dm/@react-native-firebase/functions.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/functions)           |           [![badge](https://api.rnfirebase.io/coverage/functions/badge)](https://api.rnfirebase.io/coverage/functions/detail)           |
diff --git a/docs/releases/v6.4.0.md b/docs/releases/v6.4.0.md
index a5b1474d..4e29dfc9 100644
--- a/docs/releases/v6.4.0.md
+++ b/docs/releases/v6.4.0.md
@@ -2,4 +2,3 @@
 title: v6.4.0 Release
 description: Upgrade to Messaging & bug fixes
 ---
-
diff --git a/docs/remote-config/index.md b/docs/remote-config/index.md
index 13cc8e82..6b1196ca 100644
--- a/docs/remote-config/index.md
+++ b/docs/remote-config/index.md
@@ -1,4 +1,3 @@
 ---
 redirect: /remote-config/usage
 ---
-
diff --git a/docs/remote-config/usage/index.md b/docs/remote-config/usage/index.md
index 63cbd910..e8e2d477 100644
--- a/docs/remote-config/usage/index.md
+++ b/docs/remote-config/usage/index.md
@@ -39,7 +39,7 @@ To get started, you need to define some parameters over on the [Firebase Console
 
 ![Firebase Console - Remote Config](https://images.prismic.io/invertase/87dc40bd-0da7-4d83-a87c-b12698b9818f_remote-config-console.png?auto=compress,format)
 
-Each parameter is assigned a unique "key" and values. The values can be broken down to target specific conditions (such as Android or iOS). In the above example, 
+Each parameter is assigned a unique "key" and values. The values can be broken down to target specific conditions (such as Android or iOS). In the above example,
 only Android devices would receive `enabled` for the `awesome_new_feature` parameter.
 
 ## Default values
@@ -47,10 +47,9 @@ only Android devices would receive `enabled` for the `awesome_new_feature` param
 Before fetching the parameters from Firebase, it is first important to set some default values. Default values
 help ensure that your application code runs as expected in scenarios where the device has not yet retrieved the values.
 
-
 An example of this is having no network or you have not yet fetched them within your own code.
 
-Setting default values helps to ensure that both the local device & Firebase servers are both in sync. Call the 
+Setting default values helps to ensure that both the local device & Firebase servers are both in sync. Call the
 `setDefaults` method early on in your application:
 
 ```js
@@ -83,18 +82,18 @@ remoteConfig()
     awesome_new_feature: 'disabled',
   })
   .then(() => remoteConfig().fetchAndActivate())
-  .then((activated) => {
+  .then(activated => {
     if (activated) {
-      console.log('Defaults set, fetched & activated!');    
+      console.log('Defaults set, fetched & activated!');
     } else {
-      console.log('Defaults set, however activation failed.');    
+      console.log('Defaults set, however activation failed.');
     }
   });
 ```
 
 ## Reading values
 
-With the defaults set and the remote values fetched from Firebase, we can now use the `getValue` method to get the 
+With the defaults set and the remote values fetched from Firebase, we can now use the `getValue` method to get the
 value by it's key. For example...
 
 ```js
@@ -140,7 +139,7 @@ Although Remote Config is a data-store, it is not designed for frequent reads -
 (default is 12 hours). By design, this prevents the values being able to change frequently and potentially cause users
 confusion.
 
-You can however specify your own cache length by specifically calling the `fetch` method with the number of seconds to 
+You can however specify your own cache length by specifically calling the `fetch` method with the number of seconds to
 cache the values for:
 
 ```js
diff --git a/docs/storage/usage/index.md b/docs/storage/usage/index.md
index d403db91..5a4d4e14 100644
--- a/docs/storage/usage/index.md
+++ b/docs/storage/usage/index.md
@@ -37,8 +37,8 @@ global redundancy. Storage lets you securely upload these files directly from mo
 # Usage
 
 Your files are stored in a Google Cloud Storage bucket. The files in this bucket are presented in a hierarchical structure,
-just like a file system. By creating a reference to a file, your app gains access to it. These references can then be 
-used to upload or download data, get or update metadata or delete the file. A reference can either point to a specific 
+just like a file system. By creating a reference to a file, your app gains access to it. These references can then be
+used to upload or download data, get or update metadata or delete the file. A reference can either point to a specific
 file or to a higher level node in the hierarchy.
 
 The Storage module also provides support for multiple buckets.
@@ -102,7 +102,7 @@ such as the current upload progress:
 ```js
 const task = reference.putFile(pathToFile);
 
-task.on('state_changed', (taskSnapshot) => {
+task.on('state_changed', taskSnapshot => {
   console.log(`${taskSnapshot.bytesTransferred} transferred out of ${task.totalBytes}`);
 });
 
@@ -124,7 +124,7 @@ task.resume();
 
 ## Download URLs
 
-A common use-case for Cloud Storage is to use it as a global Content Delivery Network (CDN) for your images. When uploading 
+A common use-case for Cloud Storage is to use it as a global Content Delivery Network (CDN) for your images. When uploading
 files to a bucket, they are not automatically available for consumption via a HTTP URL. To generate a new Download URL, you
 need to call the `getDownloadURL` method on a reference:
 
@@ -145,32 +145,30 @@ the `list` method. The results are however paginated, and if more results are av
 import storage from '@react-native-firebase/storage';
 
 function listFilesAndDirectories(reference, pageToken) {
-  return reference.list({ pageToken })
-    .then((result) => {
-      // Loop over each item
-      result.items.forEach((ref) => {
-        console.log(ref.fullPath);
-      });
- 
-      if (result.nextPageToken) {
-        return listFilesAndDirectories(reference, result.nextPageToken);
-      }
-      
-      return Promise.resolve();
+  return reference.list({ pageToken }).then(result => {
+    // Loop over each item
+    result.items.forEach(ref => {
+      console.log(ref.fullPath);
     });
+
+    if (result.nextPageToken) {
+      return listFilesAndDirectories(reference, result.nextPageToken);
+    }
+
+    return Promise.resolve();
+  });
 }
 
 const reference = storage().ref('images');
 
-listFilesAndDirectories(reference)
-  .then(() => {
-    console.log('Finished listing');
-  });
-``` 
+listFilesAndDirectories(reference).then(() => {
+  console.log('Finished listing');
+});
+```
 
 ## Security
 
-By default your bucket will come with rules which allows only authenticated users on your project to access it. You can 
+By default your bucket will come with rules which allows only authenticated users on your project to access it. You can
 however fully customise the security rules to your own applications requirements.
 
 To learn more, view the [Storage Security](https://firebase.google.com/docs/storage/security/start) documentation
@@ -179,8 +177,8 @@ on the Firebase website.
 ## Multiple Buckets
 
 A single Firebase project can have multiple storage buckets. The module will use the default bucket if no bucket argument
-is passed to the `storage` instance. To switch buckets, provide the module with the `gs://` bucket URL found on the 
-Firebase Console, under Storage > Files. 
+is passed to the `storage` instance. To switch buckets, provide the module with the `gs://` bucket URL found on the
+Firebase Console, under Storage > Files.
 
 ```js
 import storage from '@react-native-firebase/storage';
diff --git a/docs/typedoc.json b/docs/typedoc.json
index 896c06fa..c8847dde 100644
--- a/docs/typedoc.json
+++ b/docs/typedoc.json
@@ -42351,10 +42351,6 @@
 									}
 								]
 							},
-							"overwrites": {
-								"type": "reference",
-								"name": "Error.stack"
-							},
 							"inheritedFrom": {
 								"type": "reference",
 								"name": "Error.stack"
@@ -66541,10 +66537,6 @@
 									}
 								]
 							},
-							"overwrites": {
-								"type": "reference",
-								"name": "Error.stack"
-							},
 							"inheritedFrom": {
 								"type": "reference",
 								"name": "Error.stack"
diff --git a/docs/typedoc.min.json b/docs/typedoc.min.json
index 164b877f..97bacbe5 100644
--- a/docs/typedoc.min.json
+++ b/docs/typedoc.min.json
@@ -1 +1 @@
-{"id":0,"name":"@react-native-firebase/app - v6.4.0-rc0","kind":0,"flags":{},"children":[{"id":254,"name":"\"@react-native-firebase/admob\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":261,"name":"AdEventType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1178,"character":26}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"AdEventType","id":98}]}},{"id":264,"name":"AdsConsent","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1181,"character":25}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"AdsConsent","id":121}]}},{"id":257,"name":"AdsConsentDebugGeography","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1174,"character":39}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"AdsConsentDebugGeography","id":161}]}},{"id":258,"name":"AdsConsentStatus","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1175,"character":31}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"AdsConsentStatus","id":165}]}},{"id":267,"name":"BannerAd","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1184,"character":23}],"type":{"type":"reference","name":"React.SFC","typeArguments":[{"type":"reference","name":"BannerAd","id":234}]}},{"id":262,"name":"BannerAdSize","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1179,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"BannerAdSize","id":108}]}},{"id":265,"name":"InterstitialAd","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1182,"character":29}],"type":{"type":"reference","name":"InterstitialAd","id":204}},{"id":259,"name":"MaxAdContentRating","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1176,"character":33}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"MaxAdContentRating","id":185}]}},{"id":266,"name":"RewardedAd","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1183,"character":25}],"type":{"type":"reference","name":"RewardedAd","id":219}},{"id":263,"name":"RewardedAdEventType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1180,"character":34}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"RewardedAdEventType","id":105}]}},{"id":260,"name":"TestIds","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1177,"character":22}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"TestIds","id":117}]}},{"id":268,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1186,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":243},{"type":"reference","name":"Statics","id":90}]}},{"id":256,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1172,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":255,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1171,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[261,264,257,258,267,262,265,259,266,263,260,268,256,255]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1163,"character":45}]},{"id":548,"name":"\"@react-native-firebase/analytics\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":551,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1357,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":428},{"type":"reference","name":"Statics","id":427}]}},{"id":550,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1355,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":549,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1354,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[551,550,549]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1348,"character":49}]},{"id":80,"name":"\"@react-native-firebase/app\"","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Attach namespace to `firebase.` and `FirebaseApp.`."},"children":[{"id":83,"name":"ReactNativeFirebase","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Attach Utils namespace to `firebase.` and `FirebaseApp.`."},"children":[{"id":86,"name":"FirebaseApp","kind":256,"kindString":"Interface","flags":{},"children":[{"id":270,"name":"admob","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":271,"name":"admob","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":243}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1205,"character":11}]},{"id":553,"name":"analytics","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":554,"name":"analytics","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":428}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1378,"character":15}]},{"id":839,"name":"auth","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":840,"name":"auth","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":746}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1639,"character":10}]},{"id":881,"name":"crashlytics","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":882,"name":"crashlytics","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":843}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":254,"character":17}]},{"id":1214,"name":"database","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":1215,"name":"database","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1216,"name":"databaseUrl","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Module","id":1185}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1260,"character":14}]},{"id":1291,"name":"dynamicLinks","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":1292,"name":"dynamicLinks","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":1265}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":595,"character":18}]},{"id":1855,"name":"firestore","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":1856,"name":"firestore","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":1818}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1974,"character":15}]},{"id":1904,"name":"functions","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":1905,"name":"functions","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1906,"name":"region","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Module","id":1890}}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":367,"character":15}]},{"id":1928,"name":"iid","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":1929,"name":"iid","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":1909}}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":159,"character":9}]},{"id":1947,"name":"inAppMessaging","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":1948,"name":"inAppMessaging","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":1932}}],"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":165,"character":20}]},{"id":2118,"name":"messaging","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":2119,"name":"messaging","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":2020}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":958,"character":15}]},{"id":2156,"name":"naturalLanguage","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":2157,"name":"naturalLanguage","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":2133}}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":257,"character":21}]},{"id":2623,"name":"perf","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":2624,"name":"perf","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":2601}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":474,"character":10}]},{"id":2682,"name":"remoteConfig","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":2683,"name":"remoteConfig","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":2651}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":458,"character":18}]},{"id":2865,"name":"storage","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":2866,"name":"storage","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2867,"name":"bucket","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Module","id":2840}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1129,"character":13}]},{"id":87,"name":"utils","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":88,"name":"utils","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":77}}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":415,"character":11}]},{"id":2529,"name":"vision","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":2530,"name":"vision","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":2473}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1224,"character":12}]}],"groups":[{"title":"Methods","kind":2048,"children":[270,553,839,881,1214,1291,1855,1904,1928,1947,2118,2156,2623,2682,2865,87,2529]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":414,"character":25},{"fileName":"packages/admob/lib/index.d.ts","line":1204,"character":25},{"fileName":"packages/analytics/lib/index.d.ts","line":1377,"character":25},{"fileName":"packages/auth/lib/index.d.ts","line":1638,"character":25},{"fileName":"packages/crashlytics/lib/index.d.ts","line":253,"character":25},{"fileName":"packages/database/lib/index.d.ts","line":1259,"character":25},{"fileName":"packages/dynamic-links/lib/index.d.ts","line":594,"character":25},{"fileName":"packages/firestore/lib/index.d.ts","line":1973,"character":25},{"fileName":"packages/functions/lib/index.d.ts","line":366,"character":25},{"fileName":"packages/iid/lib/index.d.ts","line":158,"character":25},{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":164,"character":25},{"fileName":"packages/messaging/lib/index.d.ts","line":957,"character":25},{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":256,"character":25},{"fileName":"packages/ml-vision/lib/index.d.ts","line":1223,"character":25},{"fileName":"packages/perf/lib/index.d.ts","line":473,"character":25},{"fileName":"packages/remote-config/lib/index.d.ts","line":457,"character":25},{"fileName":"packages/storage/lib/index.d.ts","line":1128,"character":25}]},{"id":84,"name":"Module","kind":256,"kindString":"Interface","flags":{},"children":[{"id":269,"name":"admob","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1201,"character":11}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":243},{"type":"reference","name":"Statics","id":90}]}},{"id":552,"name":"analytics","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1371,"character":15}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":428},{"type":"reference","name":"Statics","id":427}]}},{"id":838,"name":"auth","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1636,"character":10}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":746},{"type":"reference","name":"Statics","id":587}]}},{"id":880,"name":"crashlytics","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":248,"character":17}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":843},{"type":"reference","name":"Statics","id":842}]}},{"id":1213,"name":"database","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1253,"character":14}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1185},{"type":"reference","name":"Statics","id":889}]}},{"id":1290,"name":"dynamicLinks","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":588,"character":18}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":1265},{"type":"reference","name":"Statics","id":1263}]}},{"id":1854,"name":"firestore","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1968,"character":15}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1818},{"type":"reference","name":"Statics","id":1808}]}},{"id":1903,"name":"functions","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":361,"character":15}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1890},{"type":"reference","name":"Statics","id":1888}]}},{"id":1927,"name":"iid","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":156,"character":9}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1909},{"type":"reference","name":"Statics","id":1908}]}},{"id":1946,"name":"inAppMessaging","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":158,"character":20}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":1932},{"type":"reference","name":"Statics","id":1931}]}},{"id":2117,"name":"messaging","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":951,"character":15}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":2020},{"type":"reference","name":"Statics","id":1951}]}},{"id":2155,"name":"naturalLanguage","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":250,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":2133},{"type":"reference","name":"Statics","id":2125}]}},{"id":2622,"name":"perf","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":468,"character":10}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":2601},{"type":"reference","name":"Statics","id":2600}]}},{"id":2681,"name":"remoteConfig","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":452,"character":18}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":2651},{"type":"reference","name":"Statics","id":2636}]}},{"id":2864,"name":"storage","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1123,"character":13}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":2840},{"type":"reference","name":"Statics","id":2698}]}},{"id":85,"name":"utils","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Utils provides a collection of utilities to aid in using Firebase\nand related services inside React Native, e.g. Test Lab helpers\nand Google Play Services version helpers."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":411,"character":11}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":77},{"type":"reference","name":"Statics","id":75}]}},{"id":2528,"name":"vision","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1217,"character":12}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":2473},{"type":"reference","name":"Statics","id":2287}]}}],"groups":[{"title":"Properties","kind":1024,"children":[269,552,838,880,1213,1290,1854,1903,1927,1946,2117,2155,2622,2681,2864,85,2528]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":405,"character":20},{"fileName":"packages/admob/lib/index.d.ts","line":1200,"character":20},{"fileName":"packages/analytics/lib/index.d.ts","line":1370,"character":20},{"fileName":"packages/auth/lib/index.d.ts","line":1635,"character":20},{"fileName":"packages/crashlytics/lib/index.d.ts","line":247,"character":20},{"fileName":"packages/database/lib/index.d.ts","line":1252,"character":20},{"fileName":"packages/dynamic-links/lib/index.d.ts","line":587,"character":20},{"fileName":"packages/firestore/lib/index.d.ts","line":1967,"character":20},{"fileName":"packages/functions/lib/index.d.ts","line":360,"character":20},{"fileName":"packages/iid/lib/index.d.ts","line":155,"character":20},{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":157,"character":20},{"fileName":"packages/messaging/lib/index.d.ts","line":950,"character":20},{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":249,"character":20},{"fileName":"packages/ml-vision/lib/index.d.ts","line":1216,"character":20},{"fileName":"packages/perf/lib/index.d.ts","line":467,"character":20},{"fileName":"packages/remote-config/lib/index.d.ts","line":451,"character":20},{"fileName":"packages/storage/lib/index.d.ts","line":1122,"character":20}]}],"groups":[{"title":"Interfaces","kind":256,"children":[86,84]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":402,"character":31},{"fileName":"packages/admob/lib/index.d.ts","line":1197,"character":31},{"fileName":"packages/analytics/lib/index.d.ts","line":1368,"character":31},{"fileName":"packages/auth/lib/index.d.ts","line":1633,"character":31},{"fileName":"packages/crashlytics/lib/index.d.ts","line":245,"character":31},{"fileName":"packages/database/lib/index.d.ts","line":1250,"character":31},{"fileName":"packages/dynamic-links/lib/index.d.ts","line":584,"character":31},{"fileName":"packages/firestore/lib/index.d.ts","line":1965,"character":31},{"fileName":"packages/functions/lib/index.d.ts","line":358,"character":31},{"fileName":"packages/iid/lib/index.d.ts","line":153,"character":31},{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":155,"character":31},{"fileName":"packages/messaging/lib/index.d.ts","line":948,"character":31},{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":246,"character":31},{"fileName":"packages/ml-vision/lib/index.d.ts","line":1214,"character":31},{"fileName":"packages/perf/lib/index.d.ts","line":465,"character":31},{"fileName":"packages/remote-config/lib/index.d.ts","line":449,"character":31},{"fileName":"packages/storage/lib/index.d.ts","line":1120,"character":31}]},{"id":82,"name":"module","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"comment":{"shortText":"Default Firebase export."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":394,"character":14}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"Module"}]}},{"id":81,"name":"utils","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"comment":{"shortText":"Add Utils module as a named export for `app`."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":389,"character":20}],"type":{"type":"reference","name":"ReactNativeFirebase.FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":77},{"type":"reference","name":"Statics","id":75}]}}],"groups":[{"title":"Modules","kind":2,"children":[83]},{"title":"Variables","kind":32,"children":[82,81]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":385,"character":43},{"fileName":"packages/app/lib/index.d.ts","line":398,"character":43},{"fileName":"packages/admob/lib/index.d.ts","line":1196,"character":43},{"fileName":"packages/analytics/lib/index.d.ts","line":1367,"character":43},{"fileName":"packages/auth/lib/index.d.ts","line":1632,"character":43},{"fileName":"packages/crashlytics/lib/index.d.ts","line":244,"character":43},{"fileName":"packages/database/lib/index.d.ts","line":1249,"character":43},{"fileName":"packages/dynamic-links/lib/index.d.ts","line":583,"character":43},{"fileName":"packages/firestore/lib/index.d.ts","line":1964,"character":43},{"fileName":"packages/functions/lib/index.d.ts","line":357,"character":43},{"fileName":"packages/iid/lib/index.d.ts","line":152,"character":43},{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":154,"character":43},{"fileName":"packages/messaging/lib/index.d.ts","line":947,"character":43},{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":245,"character":43},{"fileName":"packages/ml-vision/lib/index.d.ts","line":1213,"character":43},{"fileName":"packages/perf/lib/index.d.ts","line":464,"character":43},{"fileName":"packages/remote-config/lib/index.d.ts","line":448,"character":43},{"fileName":"packages/storage/lib/index.d.ts","line":1119,"character":43}]},{"id":834,"name":"\"@react-native-firebase/auth\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":837,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1622,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":746},{"type":"reference","name":"Statics","id":587}]}},{"id":836,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1620,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":835,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1619,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[837,836,835]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1613,"character":44}]},{"id":876,"name":"\"@react-native-firebase/crashlytics\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":879,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":234,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":843},{"type":"reference","name":"Statics","id":842}]}},{"id":878,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":232,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":877,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":231,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[879,878,877]}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":225,"character":51}]},{"id":1209,"name":"\"@react-native-firebase/database\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":1212,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1239,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1185},{"type":"reference","name":"Statics","id":889}]}},{"id":1211,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1237,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":1210,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1236,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[1212,1211,1210]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1230,"character":48}]},{"id":1286,"name":"\"@react-native-firebase/dynamic-links\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":1289,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":573,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":1265},{"type":"reference","name":"Statics","id":1263}]}},{"id":1288,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":571,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":1287,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":570,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[1289,1288,1287]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":564,"character":53}]},{"id":1850,"name":"\"@react-native-firebase/firestore\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":1853,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1954,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1818},{"type":"reference","name":"Statics","id":1808}]}},{"id":1852,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1952,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":1851,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1951,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[1853,1852,1851]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1945,"character":49}]},{"id":1899,"name":"\"@react-native-firebase/functions\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":1902,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":347,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1890},{"type":"reference","name":"Statics","id":1888}]}},{"id":1901,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":345,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":1900,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":344,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[1902,1901,1900]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":338,"character":49}]},{"id":1923,"name":"\"@react-native-firebase/iid\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":1926,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":142,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1909},{"type":"reference","name":"Statics","id":1908}]}},{"id":1925,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":140,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":1924,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":139,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[1926,1925,1924]}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":133,"character":43}]},{"id":1942,"name":"\"@react-native-firebase/in-app-messaging\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":1944,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":142,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":1943,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":141,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}},{"id":1945,"name":"module","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":144,"character":14}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":1932},{"type":"reference","name":"Statics","id":1931}]}}],"groups":[{"title":"Variables","kind":32,"children":[1944,1943,1945]}],"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":135,"character":56}]},{"id":2113,"name":"\"@react-native-firebase/messaging\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":2116,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":937,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":2020},{"type":"reference","name":"Statics","id":1951}]}},{"id":2115,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":935,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":2114,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":934,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[2116,2115,2114]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":928,"character":49}]},{"id":2151,"name":"\"@react-native-firebase/ml-natural-language\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":2154,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":235,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":2133},{"type":"reference","name":"Statics","id":2125}]}},{"id":2153,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":233,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":2152,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":232,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[2154,2153,2152]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":226,"character":59}]},{"id":2509,"name":"\"@react-native-firebase/ml-vision\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":2518,"name":"VisionBarcodeAddressType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1193,"character":39}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"intrinsic","name":"any"}]}},{"id":2516,"name":"VisionBarcodeEmailType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1191,"character":37}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"intrinsic","name":"any"}]}},{"id":2512,"name":"VisionBarcodeFormat","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1187,"character":34}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"intrinsic","name":"any"}]}},{"id":2517,"name":"VisionBarcodePhoneType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1192,"character":37}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"intrinsic","name":"any"}]}},{"id":2515,"name":"VisionBarcodeValueType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1190,"character":37}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"intrinsic","name":"any"}]}},{"id":2521,"name":"VisionBarcodeWifiEncryptionType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1196,"character":46}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"FirebaseVisionTypes.VisionBarcodeWifiEncryptionType"}]}},{"id":2526,"name":"VisionCloudLandmarkRecognizerModelType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1201,"character":53}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionCloudLandmarkRecognizerModelType","id":2320}]}},{"id":2523,"name":"VisionCloudTextRecognizerModelType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1198,"character":49}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionCloudTextRecognizerModelType","id":2332}]}},{"id":2525,"name":"VisionDocumentTextRecognizedBreakType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1200,"character":52}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionDocumentTextRecognizedBreakType","id":2377}]}},{"id":2513,"name":"VisionFaceContourType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1188,"character":36}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionFaceContourType","id":2452}]}},{"id":2524,"name":"VisionFaceDetectorClassificationMode","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1199,"character":51}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionFaceDetectorClassificationMode","id":2335}]}},{"id":2519,"name":"VisionFaceDetectorContourMode","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1194,"character":44}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionFaceDetectorContourMode","id":2338}]}},{"id":2520,"name":"VisionFaceDetectorLandmarkMode","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1195,"character":45}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionFaceDetectorLandmarkMode","id":2341}]}},{"id":2522,"name":"VisionFaceDetectorPerformanceMode","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1197,"character":48}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionFaceDetectorPerformanceMode","id":2344}]}},{"id":2514,"name":"VisionFaceLandmarkType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1189,"character":37}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionFaceLandmarkType","id":2438}]}},{"id":2527,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1203,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":2473},{"type":"reference","name":"Statics","id":2287}]}},{"id":2511,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1185,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":2510,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1184,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[2518,2516,2512,2517,2515,2521,2526,2523,2525,2513,2524,2519,2520,2522,2514,2527,2511,2510]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1178,"character":49}]},{"id":2618,"name":"\"@react-native-firebase/perf\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":2621,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":454,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":2601},{"type":"reference","name":"Statics","id":2600}]}},{"id":2620,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":452,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":2619,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":451,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[2621,2620,2619]}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":445,"character":44}]},{"id":2677,"name":"\"@react-native-firebase/remote-config\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":2680,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":438,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":2651},{"type":"reference","name":"Statics","id":2636}]}},{"id":2679,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":436,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":2678,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":435,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[2680,2679,2678]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":429,"character":53}]},{"id":2860,"name":"\"@react-native-firebase/storage\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":2863,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1109,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":2840},{"type":"reference","name":"Statics","id":2698}]}},{"id":2862,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1107,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":2861,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1106,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[2863,2862,2861]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1100,"character":47}]},{"id":89,"name":"FirebaseAdMobTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Admob package for React Native.","text":"#### Example: access the Firebase export from the `admob` package:\n\n```jS\nimport { firebase } from '@react-native-firebase/admob';\n\n// firebase.admob().X\n```\n\n#### Example: Using the default export from the `admob` package:\n\n```js\nimport admob from '@react-native-firebase/admob';\n\n// admob().X\n```\n\n#### Example: Using the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/admob';\n\n// firebase.admob().X\n```\n","tags":[{"tag":"firebase","text":"admob\n"}]},"children":[{"id":204,"name":"InterstitialAd","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A class for interacting and showing Interstitial Ads.","text":"An Interstitial advert can be pre-loaded and shown at a suitable point in your apps flow, such as at the end of a level\nin a game. An Interstitial is a full screen advert, laid on-top of your entire application which the user can interact with.\nInteractions are passed back via events which should be handled accordingly inside of your app.\n\n#### Example\n\nFirst create a new Interstitial instance, passing in your Ad Unit ID from the Firebase console, and any additional\nrequest options. The example below will present a test advert, and only request a non-personalized ad.\n\n```js\nimport { InterstitialAd, TestIds } from '@react-native-firebase/admob';\n\nconst interstitial = InterstitialAd.createForAdRequest(TestIds.INTERSTITIAL, {\n    requestNonPersonalizedAdsOnly: true,\n});\n ```\n\nEach advert needs to be loaded from AdMob before being shown. It is recommended this is performed before the user\nreaches the checkpoint to show the advert, so it's ready to go. Before loading the advert, we need to setup\nevent listeners to listen for updates from AdMob, such as advert loaded or failed to load.\n\nEvent types match the `AdEventType` interface. Once the advert has loaded, we can trigger it to show:\n\n```js\nimport { AdEventType } from '@react-native-firebase/admob';\n\ninterstitial.onAdEvent((type) => {\n  if (type === AdEventType.LOADED) {\n    interstitial.show();\n  }\n});\n\ninterstitial.load();\n ```\n\nThe advert will be presented to the user, and several more events can be triggered such as the user clicking the\nadvert or closing it.\n"},"children":[{"id":209,"name":"adUnitId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Ad Unit ID for this AdMob ad."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":845,"character":12}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"MobileAd.adUnitId","id":194}},{"id":210,"name":"loaded","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Whether the advert is loaded and can be shown."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":850,"character":10}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","name":"MobileAd.loaded","id":195}},{"id":211,"name":"load","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":212,"name":"load","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Start loading the advert with the provided RequestOptions.","text":"It is recommended you setup ad event handlers before calling this method.\n"},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","name":"MobileAd.load","id":196}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":857,"character":8}],"inheritedFrom":{"type":"reference","name":"MobileAd.load","id":196}},{"id":213,"name":"onAdEvent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":214,"name":"onAdEvent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to ad events. See AdEventTypes for more information.","text":"Returns an unsubscriber function to stop listening to further events.\n\n#### Example\n\n```js\n// Create InterstitialAd/RewardedAd\nconst advert = InterstitialAd.createForAdRequest('...');\n\nconst unsubscribe = advert.onAdEvent((type) => {\n\n});\n\n// Sometime later...\nunsubscribe();\n```\n"},"parameters":[{"id":215,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A listener callback containing a event type, error and data.\n"},"type":{"type":"reference","name":"AdEventListener","id":248}}],"type":{"type":"reference","name":"Function"},"inheritedFrom":{"type":"reference","name":"MobileAd.onAdEvent","id":198}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":880,"character":13}],"inheritedFrom":{"type":"reference","name":"MobileAd.onAdEvent","id":198}},{"id":216,"name":"show","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":217,"name":"show","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Show the loaded advert to the user.","text":"#### Example\n\n```js\n// Create InterstitialAd/RewardedAd\nconst advert = InterstitialAd.createForAdRequest('...');\n\nadvert.onAdEvent((type) => {\n  if (type === AdEventType.LOADED) {\n    advert.show({\n      immersiveModeEnabled: true,\n    });\n  }\n});\n```\n"},"parameters":[{"id":218,"name":"showOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional `AdShowOptions` interface.\n"},"type":{"type":"reference","name":"AdShowOptions","id":149}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"MobileAd.show","id":201}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":902,"character":8}],"inheritedFrom":{"type":"reference","name":"MobileAd.show","id":201}},{"id":205,"name":"createForAdRequest","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":206,"name":"createForAdRequest","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new InterstitialAd instance.","text":"#### Example\n\n```js\nimport { InterstitialAd, AdEventType, TestIds } from '@react-native-firebase/admob';\n\nconst interstitialAd = await InterstitialAd.request(TestIds.INTERSTITIAL, {\n  requestAgent: 'CoolAds',\n});\n\ninterstitialAd.onAdEvent((type, error) => {\n  console.log('New event: ', type, error);\n\n  if (type === AdEventType.LOADED) {\n    interstitialAd.show();\n  }\n});\n\ninterstitialAd.load();\n```\n"},"parameters":[{"id":207,"name":"adUnitId","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The Ad Unit ID for the Interstitial. You can find this on your Google AdMob dashboard."},"type":{"type":"intrinsic","name":"string"}},{"id":208,"name":"requestOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional RequestOptions used to load the ad.\n"},"type":{"type":"reference","name":"RequestOptions","id":169}}],"type":{"type":"reference","name":"InterstitialAd","id":204}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":973,"character":29}]}],"groups":[{"title":"Properties","kind":1024,"children":[209,210]},{"title":"Methods","kind":2048,"children":[211,213,216,205]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":946,"character":29}],"extendedTypes":[{"type":"reference","name":"MobileAd","id":193}]},{"id":193,"name":"MobileAd","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Base class for InterstitialAd, RewardedAd, NativeAd and BannerAd."},"children":[{"id":194,"name":"adUnitId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Ad Unit ID for this AdMob ad."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":845,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":195,"name":"loaded","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Whether the advert is loaded and can be shown."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":850,"character":10}],"type":{"type":"intrinsic","name":"boolean"}},{"id":196,"name":"load","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":197,"name":"load","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Start loading the advert with the provided RequestOptions.","text":"It is recommended you setup ad event handlers before calling this method.\n"},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":857,"character":8}]},{"id":198,"name":"onAdEvent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":199,"name":"onAdEvent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to ad events. See AdEventTypes for more information.","text":"Returns an unsubscriber function to stop listening to further events.\n\n#### Example\n\n```js\n// Create InterstitialAd/RewardedAd\nconst advert = InterstitialAd.createForAdRequest('...');\n\nconst unsubscribe = advert.onAdEvent((type) => {\n\n});\n\n// Sometime later...\nunsubscribe();\n```\n"},"parameters":[{"id":200,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A listener callback containing a event type, error and data.\n"},"type":{"type":"reference","name":"AdEventListener","id":248}}],"type":{"type":"reference","name":"Function"}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":880,"character":13}]},{"id":201,"name":"show","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":202,"name":"show","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Show the loaded advert to the user.","text":"#### Example\n\n```js\n// Create InterstitialAd/RewardedAd\nconst advert = InterstitialAd.createForAdRequest('...');\n\nadvert.onAdEvent((type) => {\n  if (type === AdEventType.LOADED) {\n    advert.show({\n      immersiveModeEnabled: true,\n    });\n  }\n});\n```\n"},"parameters":[{"id":203,"name":"showOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional `AdShowOptions` interface.\n"},"type":{"type":"reference","name":"AdShowOptions","id":149}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":902,"character":8}]}],"groups":[{"title":"Properties","kind":1024,"children":[194,195]},{"title":"Methods","kind":2048,"children":[196,198,201]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":841,"character":23}],"extendedBy":[{"type":"reference","name":"InterstitialAd","id":204},{"type":"reference","name":"RewardedAd","id":219}]},{"id":243,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Admob service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Admob service for the default app:\n\n```js\nconst defaultAppAdmob = firebase.admob();\n```\n"},"children":[{"id":247,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":244,"name":"setRequestConfiguration","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":245,"name":"setRequestConfiguration","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets request options for all future ad requests.","text":"#### Example\n\n```js\nimport admob, { MaxAdContentRating } from '@react-native-firebase/admob';\n\nawait admob().setRequestConfiguration({\n  // Update all future requests suitable for parental guidance\n  maxAdContentRating: MaxAdContentRating.PG,\n});\n```\n"},"parameters":[{"id":246,"name":"requestConfiguration","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An RequestConfiguration interface used on all future AdMob ad requests.\n"},"type":{"type":"reference","name":"RequestConfiguration","id":181}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1159,"character":27}]}],"groups":[{"title":"Properties","kind":1024,"children":[247]},{"title":"Methods","kind":2048,"children":[244]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1142,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":219,"name":"RewardedAd","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A class for interacting and showing Rewarded Ads.","text":"An Rewarded advert can be pre-loaded and shown at a suitable point in your apps flow, such as at the end of a level\nin a game. The content of a rewarded advert can be controlled via your AdMob dashboard. Typically users are rewarded\nafter completing a specific advert action (e.g. watching a video or submitting an option via an interactive form).\nEvents (such as the user earning a reward or closing a rewarded advert early) are sent back for you to handle accordingly\nwithin your application.\n\n#### Example\n\nFirst create a new Rewarded instance, passing in your Ad Unit ID from the Firebase console, and any additional\nrequest options. The example below will present a test advert, and only request a non-personalized ad.\n\n```js\nimport { RewardedAd, TestIds } from '@react-native-firebase/admob';\n\nconst rewarded = RewardedAd.createForAdRequest(TestIds.REWARDED, {\n    requestNonPersonalizedAdsOnly: true,\n});\n ```\n\nEach advert needs to be loaded from AdMob before being shown. It is recommended this is performed before the user\nreaches the checkpoint to show the advert, so it's ready to go. Before loading the advert, we need to setup\nevent listeners to listen for updates from AdMob, such as advert loaded or failed to load.\n\nEvent types match the `AdEventType` or `RewardedAdEventType` interface. The potential user reward for rewarded\nadverts are passed back to the event handler on advert load and when the user earns the reward.\n\n```js\nimport { RewardedAdEventType } from '@react-native-firebase/admob';\n\nrewarded.onAdEvent((type, error, reward) => {\n  if (type === RewardedAdEventType.LOADED) {\n    rewarded.show();\n  }\n  if (type === RewardedAdEventType.EARNED_REWARD) {\n    console.log('User earned reward of ', reward);\n  }\n});\n\nrewarded.load();\n ```\n\nThe rewarded advert will be presented to the user, and several more events can be triggered such as the user clicking the\nadvert, closing it or completing the action.\n"},"children":[{"id":224,"name":"adUnitId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Ad Unit ID for this AdMob ad."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":845,"character":12}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"MobileAd.adUnitId","id":194}},{"id":225,"name":"loaded","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Whether the advert is loaded and can be shown."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":850,"character":10}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","name":"MobileAd.loaded","id":195}},{"id":226,"name":"load","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":227,"name":"load","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Start loading the advert with the provided RequestOptions.","text":"It is recommended you setup ad event handlers before calling this method.\n"},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","name":"MobileAd.load","id":196}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":857,"character":8}],"inheritedFrom":{"type":"reference","name":"MobileAd.load","id":196}},{"id":228,"name":"onAdEvent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":229,"name":"onAdEvent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to ad events. See AdEventTypes for more information.","text":"Returns an unsubscriber function to stop listening to further events.\n\n#### Example\n\n```js\n// Create InterstitialAd/RewardedAd\nconst advert = InterstitialAd.createForAdRequest('...');\n\nconst unsubscribe = advert.onAdEvent((type) => {\n\n});\n\n// Sometime later...\nunsubscribe();\n```\n"},"parameters":[{"id":230,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A listener callback containing a event type, error and data.\n"},"type":{"type":"reference","name":"AdEventListener","id":248}}],"type":{"type":"reference","name":"Function"},"inheritedFrom":{"type":"reference","name":"MobileAd.onAdEvent","id":198}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":880,"character":13}],"inheritedFrom":{"type":"reference","name":"MobileAd.onAdEvent","id":198}},{"id":231,"name":"show","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":232,"name":"show","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Show the loaded advert to the user.","text":"#### Example\n\n```js\n// Create InterstitialAd/RewardedAd\nconst advert = InterstitialAd.createForAdRequest('...');\n\nadvert.onAdEvent((type) => {\n  if (type === AdEventType.LOADED) {\n    advert.show({\n      immersiveModeEnabled: true,\n    });\n  }\n});\n```\n"},"parameters":[{"id":233,"name":"showOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional `AdShowOptions` interface.\n"},"type":{"type":"reference","name":"AdShowOptions","id":149}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"MobileAd.show","id":201}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":902,"character":8}],"inheritedFrom":{"type":"reference","name":"MobileAd.show","id":201}},{"id":220,"name":"createForAdRequest","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":221,"name":"createForAdRequest","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new RewardedAd instance.","text":"#### Example\n\n```js\nimport { RewardedAd, RewardedAdEventType, TestIds } from '@react-native-firebase/admob';\n\nconst rewardedAd = await RewardedAd.request(TestIds.REWARDED, {\n  requestAgent: 'CoolAds',\n});\n\nrewardedAd.onAdEvent((type, error, data) => {\n  console.log('New event: ', type, error);\n\n  if (type === RewardedAdEventType.LOADED) {\n    rewardedAd.show();\n  }\n});\n\nrewardedAd.load();\n```\n"},"parameters":[{"id":222,"name":"adUnitId","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The Ad Unit ID for the Rewarded Ad. You can find this on your Google AdMob dashboard."},"type":{"type":"intrinsic","name":"string"}},{"id":223,"name":"requestOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional RequestOptions used to load the ad.\n"},"type":{"type":"reference","name":"RequestOptions","id":169}}],"type":{"type":"reference","name":"RewardedAd","id":219}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1050,"character":29}]}],"groups":[{"title":"Properties","kind":1024,"children":[224,225]},{"title":"Methods","kind":2048,"children":[226,228,231,220]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1023,"character":25}],"extendedTypes":[{"type":"reference","name":"MobileAd","id":193}]},{"id":98,"name":"AdEventType","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Common event types for ads."},"children":[{"id":102,"name":"CLICKED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The user clicked the advert."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":140,"character":11}],"type":{"type":"stringLiteral","value":"clicked"}},{"id":104,"name":"CLOSED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The user closed the ad and has returned back to your application."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":152,"character":10}],"type":{"type":"stringLiteral","value":"closed"}},{"id":100,"name":"ERROR","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The ad has thrown an error. See the error parameter the listener callback for more information.","text":"#### Example\n\n```js\nimport { AdEventType } from '@react-native-firebase/admob';\n\nadvert.onAdEvent((type, error, data) => {\n  if (type === AdEventType.ERROR) {\n    console.log('Ad error:', error);\n  }\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":129,"character":9}],"type":{"type":"stringLiteral","value":"error"}},{"id":103,"name":"LEFT_APPLICATION","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The user has left your application (e.g. following the ad).","text":"Be sure to pause any tasks on this event (such as music or memory intensive tasks).\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":147,"character":20}],"type":{"type":"stringLiteral","value":"left_application"}},{"id":99,"name":"LOADED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"When an ad has loaded. At this point, the ad is ready to be shown to the user.","text":"#### Example\n\n```js\nimport { AdEventType } from '@react-native-firebase/admob';\n\nadvert.onAdEvent((type,error,data) => {\n  if (type === AdEventType.LOADED) {\n    advert.show();\n  }\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":112,"character":10}],"type":{"type":"stringLiteral","value":"loaded"}},{"id":101,"name":"OPENED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The ad opened and is currently visible to the user. This event is fired after the `show()`\nmethod has been called."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":135,"character":10}],"type":{"type":"stringLiteral","value":"opened"}}],"groups":[{"title":"Properties","kind":1024,"children":[102,104,100,103,99,101]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":96,"character":30}]},{"id":157,"name":"AdProvider","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A AdProvider interface returned from `AdsConsent.getProviders`."},"children":[{"id":158,"name":"companyId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A provider company ID."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":579,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":159,"name":"companyName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A provider company name."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":584,"character":15}],"type":{"type":"intrinsic","name":"string"}},{"id":160,"name":"privacyPolicyUrl","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A fully formed URL for the privacy policy of the provider."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":589,"character":20}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[158,159,160]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":575,"character":29}]},{"id":149,"name":"AdShowOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `AdShowOptions` interface used when showing an ad."},"children":[{"id":150,"name":"immersiveModeEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"- On Android, enables [immersive mode](https://developer.android.com/training/system-ui/immersive).\n- On iOS, this has no effect on how the ad is shown.","tags":[{"tag":"android","text":"\n"}]},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":525,"character":24}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[150]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":518,"character":32}]},{"id":121,"name":"AdsConsent","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Under the Google [EU User Consent Policy](https://www.google.com/about/company/consentstaging.html), you must make certain disclosures to your users in the European Economic Area (EEA)\nand obtain their consent to use cookies or other local storage, where legally required, and to use personal data\n(such as AdID) to serve ads. This policy reflects the requirements of the EU ePrivacy Directive and the\nGeneral Data Protection Regulation (GDPR).","text":"It is recommended that you determine the status of a user's consent at every app launch. The user consent status is held\non the device until a condition changes which requires the user to consent again, such as a change in publishers.\n\nFor more information, see [here](https://developers.google.com/admob/android/eu-consent#delay_app_measurement_optional).\n"},"children":[{"id":141,"name":"addTestDevices","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":142,"name":"addTestDevices","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"If using a real device to test, ensure the device ID is provided to the Google AdMob SDK so any mock debug locations\ncan take effect.","text":"Emulators are automatically whitelisted and require no action.\n\nIf you are unsure of how to obtain a device ID, see [react-native-device-info](https://github.com/react-native-community/react-native-device-info).\n"},"parameters":[{"id":143,"name":"deviceIds","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An array of testing device ID.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":482,"character":18}]},{"id":128,"name":"getAdProviders","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":129,"name":"getAdProviders","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a list of ad providers currently in use for the given AdMob App ID.","text":"If requesting consent from the user via your own method, this list of ad providers must be shown to the user\nfor them to accept consent.\n\n#### Example\n\n```js\nimport { AdsConsent } from '@react-native-firebase/admob';\n\nconst providers = await AdsConsent.getAdProviders();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"AdProvider","id":157}}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":371,"character":18}]},{"id":136,"name":"getStatus","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":137,"name":"getStatus","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the current consent status of the user.","text":"> The user consent status may change at any time, therefore don't reuse old values locally and always request the current value at any time consent is required.\n\n#### Example\n\n```js\nimport { AdsConsent } from '@react-native-firebase/admob';\n\nconst status = await AdsConsent.getStatus();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"union","types":[{"type":"reference","name":"AdsConsentStatus.UNKNOWN","id":166},{"type":"reference","name":"AdsConsentStatus.NON_PERSONALIZED","id":167},{"type":"reference","name":"AdsConsentStatus.PERSONALIZED","id":168}]}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":445,"character":13}]},{"id":122,"name":"requestInfoUpdate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":123,"name":"requestInfoUpdate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Requests user consent for a given list of publisher IDs.","text":"The list of publisher IDs can be obtained from the settings panel on the Google AdMob console. If the list of\npublisher IDs has changed since the last time a user provided consent, their consent status will be reset to\n'UNKNOWN' and they must provide consent again.\n\nIf the request fails with the error \"Could not parse Event FE preflight response\", this means the state of your\nGoogle AdMob account is not complete. Ensure you have validated your account and have setup valid payment\ninformation. This error is also thrown when a Publisher ID is invalid.\n\nThe response from this method provides request location and consent status properties.\n\nIf request location is within the EEA or unknown, and the consent status is also unknown, you\nmust request consent via the `showForm()` method or your own means.\n\nIf the consent status is not unknown, the user has already previously provided consent for the current publisher\nscope.\n\n#### Example\n\n```js\nimport { AdsConsent } from '@react-native-firebase/admob';\n\nconst consent = await AdsConsent.requestInfoUpdate(['pub-6189033257628554']);\nconsole.log('User location within EEA or Unknown:', consent.isRequestLocationInEeaOrUnknown);\nconsole.log('User consent status:', consent.status);\n```\n"},"parameters":[{"id":124,"name":"publisherIds","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A list of publisher IDs found on your Google AdMob dashboard.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"AdsConsentInfo","id":154}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":303,"character":21}]},{"id":130,"name":"setDebugGeography","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":131,"name":"setDebugGeography","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the debug geography to locally test consent.","text":"If debugging on an emulator (where location cannot be determined) or outside of the EEA,\nit is possible set your own location to test how your app handles different scenarios.\n\nIf using a real device, ensure you have set it as a test device via `addTestDevice()` otherwise this method will have\nno effect.\n\n#### Example\n\n```js\nimport { AdsConsent, AdsConsentDebugGeography } from '@react-native-firebase/admob';\n\n// Set disabled\nawait AdsConsentDebugGeography.setDebugGeography(AdsConsentDebugGeography.DISABLED);\n\n// Set within EEA\nawait AdsConsentDebugGeography.setDebugGeography(AdsConsentDebugGeography.EEA);\n\n// Set outside EEA\nawait AdsConsentDebugGeography.setDebugGeography(AdsConsentDebugGeography.NOT_EEA);\n```\n"},"parameters":[{"id":132,"name":"geography","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The debug geography location.\n"},"type":{"type":"union","types":[{"type":"reference","name":"AdsConsentDebugGeography.DISABLED","id":162},{"type":"reference","name":"AdsConsentDebugGeography.EEA","id":163},{"type":"reference","name":"AdsConsentDebugGeography.NOT_EEA","id":164}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":399,"character":21}]},{"id":133,"name":"setStatus","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":134,"name":"setStatus","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Manually update the consent status of the user.","text":"This method is used when providing your own means of user consent. If using the Google-rendered form via `showForm()`,\nthe consent status is automatically set and calling this method is not required.\n\nThis method can also be used to reset the consent status, by setting it to `AdsConsentStatus.UNKNOWN`, which may be useful in certain circumstances.\n\n#### Example\n\n```js\nimport { AdsConsent, AdsConsentStatus } from '@react-native-firebase/admob';\n\n// User accepted personalized ads\nawait AdsConsent.setStatus(AdsConsentStatus.PERSONALIZED);\n```\n"},"parameters":[{"id":135,"name":"status","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The user consent status.\n"},"type":{"type":"union","types":[{"type":"reference","name":"AdsConsentStatus.UNKNOWN","id":166},{"type":"reference","name":"AdsConsentStatus.NON_PERSONALIZED","id":167},{"type":"reference","name":"AdsConsentStatus.PERSONALIZED","id":168}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":425,"character":13}]},{"id":138,"name":"setTagForUnderAgeOfConsent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":139,"name":"setTagForUnderAgeOfConsent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"If a publisher is aware that the user is under the age of consent, all ad requests must set TFUA (Tag For Users\nUnder the Age of consent in Europe). This setting takes effect for all future ad requests.","text":"Once the TFUA setting is enabled, the Google-rendered consent form will fail to load. All ad requests that include\nTFUA will be made ineligible for personalized advertising and remarketing. TFUA disables requests to third-party\nad technology providers, such as ad measurement pixels and third-party ad servers.\n\nTo remove TFUA from ad requests, set the value to `false`.\n\n#### Example\n\n```js\nimport { AdsConsent } from '@react-native-firebase/admob';\n\n// User is under age of consent\nawait AdsConsent.setTagForUnderAgeOfConsent(true);\n```\n"},"parameters":[{"id":140,"name":"tag","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The boolean value to tag for under age consent.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":470,"character":30}]},{"id":125,"name":"showForm","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":126,"name":"showForm","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Shows a Google-rendered user consent form.","text":"The Google-rendered consent form is a full-screen configurable form that displays over your app content. The form\nallows the following configuration options:\n\n\n1. Consent to view personalized ads (via `withPersonalizedAds`).\n2. Consent to view non-personalized ads (via `withNonPersonalizedAds`).\n3. Use a paid version of the app instead of viewing ads (via `withAdFree`).\n\nEvery consent form requires a privacy policy URL which outlines the usage of your application.\n\nYou should review the consent text carefully: what appears by default is a message that might be appropriate if\nyou use Google to monetize your app.\n\nIf providing an ad-free version of your app, ensure you handle this once the form has been handled by the user\nvia the `userPrefersAdFree` property. The users preference on consent is automatically forwarded onto the Google\nMobile SDKs and saved.\n\nIf the user is outside of the EEA, the request form will error.\n\n#### Example\n\n```js\nimport { AdsConsent, AdsConsentStatus } from '@react-native-firebase/admob';\n\nasync function requestConsent() {\n  const consent = await AdsConsent.requestInfoUpdate(['pub-6189033257628554']);\n\n  // Check if user requires consent\n  if (consent.isRequestLocationInEeaOrUnknown && consent.status === AdsConsentStatus.UNKNOWN) {\n    // Show a Google-rendered form\n    const result = await AdsConsent.showForm({\n      privacyPolicy: 'https://invertase.io/privacy-policy',\n      withPersonalizedAds: true,\n      withNonPersonalizedAds: true,\n      withAdFree: true,\n    });\n\n    console.log('User accepted personalized: ', result.status === AdsConsentStatus.PERSONALIZED);\n    console.log('User accepted non-personalized: ', result.status === AdsConsentStatus.NON_PERSONALIZED);\n    console.log('User prefers Ad Free version of app: ', result.userPrefersAdFree);\n  }\n}\n\n```\n"},"parameters":[{"id":127,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An AdsConsentFormOptions interface to control the Google-rendered form.\n"},"type":{"type":"reference","name":"AdsConsentFormOptions","id":144}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"AdsConsentFormResult","id":151}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":355,"character":12}]}],"groups":[{"title":"Methods","kind":2048,"children":[141,128,136,122,130,133,138,125]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":271,"character":29}]},{"id":161,"name":"AdsConsentDebugGeography","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"AdsConsentDebugGeography interface.","text":"Used to set a mock location when testing the `AdsConsent` helper.\n"},"children":[{"id":162,"name":"DISABLED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Disable any debug geography."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":601,"character":12}],"type":{"type":"unknown","name":"0"}},{"id":163,"name":"EEA","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Sets the location to within the EEA."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":606,"character":7}],"type":{"type":"unknown","name":"1"}},{"id":164,"name":"NOT_EEA","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Sets the location to outside of the EEA."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":611,"character":11}],"type":{"type":"unknown","name":"2"}}],"groups":[{"title":"Properties","kind":1024,"children":[162,163,164]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":597,"character":43}]},{"id":144,"name":"AdsConsentFormOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The options used to show on the Google-rendered consent form. At least one of `withAdFree`, `withPersonalizedAds` and `WithNonPersonalizedAds` needs to be set to `true`."},"children":[{"id":145,"name":"privacyPolicy","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A fully formed HTTP or HTTPS privacy policy URL for your application.","text":"Users will have the option to visit this web page before consenting to ads.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":494,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":148,"name":"withAdFree","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Set to `true` to provide the option for the user to choose an ad-free version of your app, defaults to `false`.","text":"If the user chooses this option, you must handle it as required (e.g. navigating to a paid version of the app,\nor a subscribe view).\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":512,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":147,"name":"withNonPersonalizedAds","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Set to `true` to provide the option for the user to accept being shown non-personalized ads, defaults to `false`."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":504,"character":26}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":146,"name":"withPersonalizedAds","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Set to `true` to provide the option for the user to accept being shown personalized ads, defaults to `false`."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":499,"character":23}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[145,148,147,146]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":488,"character":40}]},{"id":151,"name":"AdsConsentFormResult","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The result of a Google-rendered consent form."},"children":[{"id":152,"name":"status","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The consent status of the user after closing the consent form.","text":"- UNKNOWN: The form was unable to determine the users consent status.\n- NON_PERSONALIZED: The user has accepted non-personalized ads.\n- PERSONALIZED: The user has accepted personalized ads.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":539,"character":10}],"type":{"type":"union","types":[{"type":"reference","name":"AdsConsentStatus.UNKNOWN","id":166},{"type":"reference","name":"AdsConsentStatus.NON_PERSONALIZED","id":167},{"type":"reference","name":"AdsConsentStatus.PERSONALIZED","id":168}]}},{"id":153,"name":"userPrefersAdFree","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If `true`, the user requested an ad-free version of your application."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":547,"character":21}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[152,153]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":531,"character":39}]},{"id":154,"name":"AdsConsentInfo","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The result of requesting info about a users consent status."},"children":[{"id":156,"name":"isRequestLocationInEeaOrUnknown","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If `true` the user is within the EEA or their location could not be determined."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":569,"character":35}],"type":{"type":"intrinsic","name":"boolean"}},{"id":155,"name":"status","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The consent status of the user.","text":"- UNKNOWN: The consent status is unknown and the user must provide consent to show ads if they are within the EEA or location is also unknown.\n- NON_PERSONALIZED: The user has accepted non-personalized ads.\n- PERSONALIZED: The user has accepted personalized ads.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":561,"character":10}],"type":{"type":"union","types":[{"type":"reference","name":"AdsConsentStatus.UNKNOWN","id":166},{"type":"reference","name":"AdsConsentStatus.NON_PERSONALIZED","id":167},{"type":"reference","name":"AdsConsentStatus.PERSONALIZED","id":168}]}}],"groups":[{"title":"Properties","kind":1024,"children":[156,155]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":553,"character":33}]},{"id":165,"name":"AdsConsentStatus","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"AdsConsentStatus interface."},"children":[{"id":167,"name":"NON_PERSONALIZED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The user has accepted non-personalized ads."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":626,"character":20}],"type":{"type":"unknown","name":"1"}},{"id":168,"name":"PERSONALIZED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The user has accepted personalized ads."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":631,"character":16}],"type":{"type":"unknown","name":"2"}},{"id":166,"name":"UNKNOWN","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The consent status is unknown and the user must provide consent to show ads if they are within the EEA or location is also unknown."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":621,"character":11}],"type":{"type":"unknown","name":"0"}}],"groups":[{"title":"Properties","kind":1024,"children":[167,168,166]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":617,"character":35}]},{"id":234,"name":"BannerAd","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An interface for a Banner advert component.","text":"#### Example\n\nThe `BannerAd` interface is exposed as a React component, allowing you to integrate ads within your existing React\nNative code base. The component itself is isolated, meaning any standard `View` props (e.g. `style`) are not\nforwarded on. It is recommended you wrap the `BannerAd` within your own `View` if you wish to apply custom props for use-cases\nsuch as positioning.\n\n```js\nimport { BannerAd, BannerAdSize, TestIds } from '@react-native-firebase/admob';\n\nfunction HomeScreen() {\n  return (\n    <BannerAd\n      unitId={TestIds.BANNER}\n      size={BannerAdSize.FULL_BANNER}\n      requestOptions={{\n        requestNonPersonalizedAdsOnly: true,\n      }}\n      onAdLoaded={() => {\n        console.log('Advert loaded');\n      }}\n      onAdFailedToLoad={(error) => {\n        console.error('Advert failed to load: ', error);\n      }}\n    />\n  );\n}\n```\n"},"children":[{"id":241,"name":"onAdClosed","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Called when the user is about to return to the app after tapping on an ad."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1121,"character":14}],"type":{"type":"reference","name":"Function"}},{"id":239,"name":"onAdFailedToLoad","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"When an ad has failed to load. Callback contains an Error."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1111,"character":20}],"type":{"type":"reference","name":"Function"}},{"id":242,"name":"onAdLeftApplication","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Called when the user has left the application (e.g. clicking an advert)."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1126,"character":23}],"type":{"type":"reference","name":"Function"}},{"id":238,"name":"onAdLoaded","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"When an ad has finished loading."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1106,"character":14}],"type":{"type":"reference","name":"Function"}},{"id":240,"name":"onAdOpened","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The ad is now visible to the user."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1116,"character":14}],"type":{"type":"reference","name":"Function"}},{"id":237,"name":"requestOptions","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The request options for this banner."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1101,"character":18}],"type":{"type":"reference","name":"RequestOptions","id":169}},{"id":236,"name":"size","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The size of the banner. Can be a predefined size via `BannerAdSize` or custom dimensions, e.g. `300x200`.","text":"Inventory must be available for the banner size specified, otherwise a no-fill error will be sent to `onAdFailedToLoad`.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1096,"character":8}],"type":{"type":"union","types":[{"type":"reference","name":"BannerAdSize","id":108},{"type":"intrinsic","name":"string"}]}},{"id":235,"name":"unitId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The AdMob unit ID for the banner."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1089,"character":10}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[241,239,242,238,240,237,236,235]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1085,"character":27}]},{"id":108,"name":"BannerAdSize","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Used to sets the size of an Advert."},"children":[{"id":109,"name":"BANNER","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels)."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":213,"character":10}],"type":{"type":"stringLiteral","value":"BANNER"}},{"id":115,"name":"FLUID","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A dynamically sized banner that matches its parent's width and expands/contracts its height to match the ad's content after loading completes."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":243,"character":9}],"type":{"type":"stringLiteral","value":"FLUID"}},{"id":110,"name":"FULL_BANNER","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels)."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":218,"character":15}],"type":{"type":"stringLiteral","value":"FULL_BANNER"}},{"id":111,"name":"LARGE_BANNER","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Large banner ad size (320x100 density-independent pixels)."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":223,"character":16}],"type":{"type":"stringLiteral","value":"LARGE_BANNER"}},{"id":112,"name":"LEADERBOARD","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels)."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":228,"character":15}],"type":{"type":"stringLiteral","value":"LEADERBOARD"}},{"id":113,"name":"MEDIUM_RECTANGLE","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels)."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":233,"character":20}],"type":{"type":"stringLiteral","value":"MEDIUM_RECTANGLE"}},{"id":114,"name":"SMART_BANNER","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A dynamically sized banner that is full-width and auto-height."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":238,"character":16}],"type":{"type":"stringLiteral","value":"SMART_BANNER"}},{"id":116,"name":"WIDE_SKYSCRAPER","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"IAB wide skyscraper ad size (160x600 density-independent pixels). This size is currently not supported by the Google Mobile Ads network; this is intended for mediation ad networks only."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":248,"character":19}],"type":{"type":"stringLiteral","value":"WIDE_SKYSCRAPER"}}],"groups":[{"title":"Properties","kind":1024,"children":[109,115,110,111,112,113,114,116]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":209,"character":31}]},{"id":185,"name":"MaxAdContentRating","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The MaxAdContentRating interface used when setting global advert request options."},"children":[{"id":186,"name":"G","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"\"General audiences.\" Content suitable for all audiences, including families and children."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":784,"character":5}],"type":{"type":"stringLiteral","value":"G"}},{"id":189,"name":"MA","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"\"Mature audiences.\" Content suitable only for mature audiences; includes topics such as alcohol, gambling, sexual content, and weapons."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":799,"character":6}],"type":{"type":"stringLiteral","value":"MA"}},{"id":187,"name":"PG","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"\"Parental guidance.\" Content suitable for most audiences with parental guidance, including topics like non-realistic, cartoonish violence."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":789,"character":6}],"type":{"type":"stringLiteral","value":"PG"}},{"id":188,"name":"T","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"T: \"Teen.\" Content suitable for teen and older audiences, including topics such as general health, social networks, scary imagery, and fight sports."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":794,"character":5}],"type":{"type":"stringLiteral","value":"T"}}],"groups":[{"title":"Properties","kind":1024,"children":[186,189,187,188]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":780,"character":37}]},{"id":181,"name":"RequestConfiguration","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The `RequestConfiguration` used when setting global ad settings via `setRequestConfiguration`."},"children":[{"id":182,"name":"maxAdContentRating","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The maximum ad content rating for all ads.  AdMob ads returns ads at or below the specified level.","text":"Ratings are based on the [digital content label classifications](https://support.google.com/admob/answer/7562142).\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":750,"character":22}],"type":{"type":"union","types":[{"type":"reference","name":"MaxAdContentRating.G","id":186},{"type":"reference","name":"MaxAdContentRating.PG","id":187},{"type":"reference","name":"MaxAdContentRating.T","id":188},{"type":"reference","name":"MaxAdContentRating.MA","id":189}]}},{"id":183,"name":"tagForChildDirectedTreatment","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If `true`, indicates that you want your content treated as child-directed for purposes of COPPA.","text":"For purposes of the [Children's Online Privacy Protection Act (COPPA)](http://business.ftc.gov/privacy-and-security/children%27s-privacy),\nthere is a setting called \"tag for child-directed treatment\". By setting this tag, you certify that this notification\nis accurate and you are authorized to act on behalf of the owner of the app. You understand that abuse of this\nsetting may result in termination of your Google account.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":764,"character":32}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":184,"name":"tagForUnderAgeOfConsent","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If `true`, indicates that you want the ad request to be handled in a manner suitable for users under the age of consent.","text":"You can mark your ad requests to receive treatment for users in the European Economic Area (EEA) under the age of consent.\nThis feature is designed to help facilitate compliance with the [General Data Protection Regulation (GDPR)](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:32016R0679).\n\nSee the [Google Mobile SDK docs](https://developers.google.com/admob/android/targeting#ad_content_filtering) for more information.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":774,"character":27}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[182,183,184]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":744,"character":39}]},{"id":169,"name":"RequestOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The `RequestOptions` interface. Used when passing additional request options before an advert is loaded."},"children":[{"id":177,"name":"contentUrl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets a content URL for targeting purposes.","text":"Max length of 512.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":698,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":175,"name":"keywords","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An array of keywords to be sent when loading the ad.","text":"Setting keywords helps deliver more specific ads to a user based on the keywords.\n\n#### Example\n\n```js\nawait Interstitial.request('ca-app-pub-3940256099942544/1033173712', {\n  keywords: ['fashion', 'clothing'],\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":678,"character":12}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":178,"name":"location","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The latitude and longitude location of the user.","text":"Ensure your app requests location permissions from the user.\n\n#### Example\n\n```js\nawait Interstitial.request('ca-app-pub-3940256099942544/1033173712', {\n  location: [53.481073, -2.237074],\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":713,"character":12}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":179,"name":"locationAccuracy","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the location accuracy if the location is set, in meters.","text":"This option is only applied to iOS devices. On Android, this option has no effect.\n","tags":[{"tag":"ios","text":"\n"}]},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":722,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":171,"name":"networkExtras","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Attaches additional properties to an ad request for direct campaign delivery.","text":"Takes an array of string key/value pairs.\n\n#### Example\n\nAttaches `?campaign=abc&user=123` to the ad request:\n\n```js\nawait Interstitial.request('ca-app-pub-3940256099942544/1033173712', {\n  networkExtras: {\n    campaign: 'abc',\n    user: '123',\n  },\n});\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":663,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":172,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":173,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":174,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}]}}]}},{"id":180,"name":"requestAgent","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the request agent string to identify the ad request's origin. Third party libraries that reference the Mobile\nAds SDK should call this method to denote the platform from which the ad request originated. For example, if a\nthird party ad network called \"CoolAds network\" mediates requests to the Mobile Ads SDK, it should call this\nmethod with \"CoolAds\".","text":"#### Example\n\n```js\nawait Interstitial.request('ca-app-pub-3940256099942544/1033173712', {\n  requestAgent: 'CoolAds',\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":738,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":170,"name":"requestNonPersonalizedAdsOnly","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If `true` only non-personalized ads will be loaded.","text":"Google serves personalized ads by default. This option must be `true` if users who are within the EEA have only\ngiven consent to non-personalized ads.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":644,"character":33}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":176,"name":"testDevices","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An array of test device IDs to whitelist.","text":"If using an emulator, set the device ID to `EMULATOR`.\n\n```js\nawait Interstitial.request('ca-app-pub-3940256099942544/1033173712', {\n  testDevices: ['EMULATOR'],\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":691,"character":15}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"groups":[{"title":"Properties","kind":1024,"children":[177,175,178,179,171,180,170,176]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":637,"character":33}]},{"id":105,"name":"RewardedAdEventType","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Ad event types specially for `RewardedAd`."},"children":[{"id":107,"name":"EARNED_REWARD","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An event fired when the user earned the reward for the video. If the user does not earn a reward,\nthe `AdEventType.CLOSED` event will be fired with no rewarded event.","text":"The reward contains a `type` and `amount`.\n\n#### Example\n\n```js\nimport { RewardedAdEventType } from '@react-native-firebase/admob';\n\nrewardedAd.onAdEvent((type, error, data) => {\n  if (type === RewardedAdEventType.EARNED_REWARD) {\n    console.log(`User earned ${data.amount} ${data.type}`);\n    // E.g. \"User earned 50 coins\"\n  }\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":203,"character":17}],"type":{"type":"stringLiteral","value":"rewarded_earned_reward"}},{"id":106,"name":"LOADED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An event fired when a rewarded ad has loaded.","text":"This type differs from `AdEventType.LOADED` as when a rewarded ad is loaded,\nan additional data payload is provided to the event handler containing the ad reward\n(assuming the user earns the reward).\n\nThe reward contains a `type` and `amount`.\n\n#### Example\n\n```js\nimport { RewardedAdEventType } from '@react-native-firebase/admob';\n\nrewardedAd.onAdEvent((type, error, data) => {\n  if (type === RewardedAdEventType.LOADED) {\n    console.log(`Rewarded Ad loaded with ${data.amount} ${data.type} as reward`);\n    // E.g. \"Rewarded Ad loaded with 50 coins as reward\"\n    rewardedAd.show();\n  }\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":182,"character":10}],"type":{"type":"stringLiteral","value":"rewarded_loaded"}}],"groups":[{"title":"Properties","kind":1024,"children":[107,106]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":158,"character":38}]},{"id":190,"name":"RewardedAdReward","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `RewardedAdReward` returned from rewarded ads."},"children":[{"id":192,"name":"amount","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The number value of the reward, e.g. 10"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":814,"character":10}],"type":{"type":"intrinsic","name":"number"}},{"id":191,"name":"type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The reward name, e.g. 'coins', 'diamonds'."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":809,"character":8}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[192,191]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":805,"character":35}]},{"id":90,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"firebase.admob.X"},"children":[{"id":94,"name":"AdEventType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"AdEventType enum."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":75,"character":15}],"type":{"type":"reference","name":"AdEventType","id":98}},{"id":92,"name":"AdsConsentDebugGeography","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"AdsConsentDebugGeography interface."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":65,"character":28}],"type":{"type":"reference","name":"AdsConsentDebugGeography","id":161}},{"id":91,"name":"AdsConsentStatus","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"AdsConsentStatus interface."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":60,"character":20}],"type":{"type":"reference","name":"AdsConsentStatus","id":165}},{"id":97,"name":"BannerAdSize","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Used to sets the size of an Advert."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":90,"character":16}],"type":{"type":"reference","name":"BannerAdSize","id":108}},{"id":93,"name":"MaxAdContentRating","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"AdsConsentDebugGeography interface."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":70,"character":22}],"type":{"type":"reference","name":"MaxAdContentRating","id":185}},{"id":95,"name":"RewardedAdEventType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"RewardedAdEventType enum."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":80,"character":23}],"type":{"type":"reference","name":"RewardedAdEventType","id":105}},{"id":96,"name":"TestIds","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"TestIds interface"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":85,"character":11}],"type":{"type":"reference","name":"TestIds","id":117}}],"groups":[{"title":"Properties","kind":1024,"children":[94,92,91,97,93,95,96]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":56,"character":26}]},{"id":117,"name":"TestIds","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Ad Unit IDs used for testing purposes. These should not be used in production apps."},"children":[{"id":118,"name":"BANNER","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":255,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":119,"name":"INTERSTITIAL","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":256,"character":16}],"type":{"type":"intrinsic","name":"string"}},{"id":120,"name":"REWARDED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":257,"character":12}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[118,119,120]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":254,"character":26}]},{"id":248,"name":"AdEventListener","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"A callback interface for all ad events.","tags":[{"tag":"param","text":"The event type, e.g. `AdEventType.LOADED`.","param":"type"},{"tag":"param","text":"An optional JavaScript Error containing the error code and message.","param":"error"},{"tag":"param","text":"Optional data for the event, e.g. reward type and amount\n","param":"data"}]},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":824,"character":29}],"type":{"type":"reflection","declaration":{"id":249,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":250,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":251,"name":"type","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"reference","name":"AdEventType.LOADED","id":99},{"type":"reference","name":"AdEventType.ERROR","id":100},{"type":"reference","name":"AdEventType.OPENED","id":101},{"type":"reference","name":"AdEventType.CLICKED","id":102},{"type":"reference","name":"AdEventType.LEFT_APPLICATION","id":103},{"type":"reference","name":"AdEventType.CLOSED","id":104},{"type":"reference","name":"RewardedAdEventType.LOADED","id":106},{"type":"reference","name":"RewardedAdEventType.EARNED_REWARD","id":107}]}},{"id":252,"name":"error","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"Error","id":10}},{"id":253,"name":"data","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"any"},{"type":"reference","name":"RewardedAdReward","id":190}]}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":824,"character":31}]}}}],"groups":[{"title":"Classes","kind":128,"children":[204,193,243,219]},{"title":"Interfaces","kind":256,"children":[98,157,149,121,161,144,151,154,165,234,108,185,181,169,105,190,90,117]},{"title":"Type aliases","kind":4194304,"children":[248]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":50,"character":35}]},{"id":275,"name":"FirebaseAnalyticsTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Analytics package for React Native.","text":"#### Example: Access the firebase export from the `analytics` package:\n\n```js\nimport { firebase } from '@react-native-firebase/analytics';\n\n// firebase.analytics().X\n```\n\n#### Example: Using the default export from the `analytics` package:\n\n```js\nimport analytics from '@react-native-firebase/analytics';\n\n// analytics().X\n```\n\n#### Example: Using the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/analytics';\n\n// firebase.analytics().X\n```\n","tags":[{"tag":"firebase","text":"analytics\n"}]},"children":[{"id":428,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Analytics service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Analytics service for the default app:\n\n```js\nconst defaultAppAnalytics = firebase.analytics();\n```\n"},"children":[{"id":547,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":464,"name":"logAddPaymentInfo","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":465,"name":"logAddPaymentInfo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Add Payment Info event. This event signifies that a user has submitted their payment information to your app.","text":"Logged event name: `add_payment_info`\n\n#### Example\n\n```js\nawait firebase.analytics().logAddPaymentInfo();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":809,"character":21}]},{"id":466,"name":"logAddToCart","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":467,"name":"logAddToCart","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"E-Commerce Add To Cart event. This event signifies that an item was added to a cart for purchase.\nAdd this event to a funnel with {@link analytics#logEcommercePurchase} to gauge the effectiveness of your checkout process.","text":"If you supply the VALUE parameter, you must also supply the CURRENCY parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `add_to_cart`\n\n#### Example\n\n```js\nawait firebase.analytics().logAddToCart({\n  item_id: 'abcd',\n  item_name: 't-shirt 1',\n  item_category: 'shirts',\n  quantity: 2,\n});\n```\n"},"parameters":[{"id":468,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.AddToCartEventParameters}.\n"},"type":{"type":"reference","name":"AddToCartEventParameters","id":276}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":832,"character":16}]},{"id":469,"name":"logAddToWishlist","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":470,"name":"logAddToWishlist","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"E-Commerce Add To Wishlist event. This event signifies that an item was added to a wishlist.\nUse this event to identify popular gift items in your app.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `add_to_wishlist`\n\n#### Example\n\n```js\nawait firebase.analytics().logAddToWishlist({\n  item_id: 'abcd',\n  item_name: 't-shirt 1',\n  item_category: 'shirts',\n  quantity: 2,\n});\n```\n"},"parameters":[{"id":471,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.AddToWishlistEventParameters}.\n"},"type":{"type":"reference","name":"AddToWishlistEventParameters","id":289}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":855,"character":20}]},{"id":472,"name":"logAppOpen","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":473,"name":"logAppOpen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"App Open event. By logging this event when an App is moved to the foreground, developers can\nunderstand how often users leave and return during the course of a Session. Although Sessions\nare automatically reported, this event can provide further clarification around the continuous\nengagement of app-users.","text":"Logged event name: `app_open`\n\n#### Example\n\n```js\nawait firebase.analytics().logAppOpen();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":871,"character":14}]},{"id":474,"name":"logBeginCheckout","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":475,"name":"logBeginCheckout","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"E-Commerce Begin Checkout event. This event signifies that a user has begun the process of\nchecking out. Add this event to a funnel with your {@link analytics#logEcommercePurchase} event to gauge the\neffectiveness of your checkout process.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `begin_checkout`\n\n#### Example\n\n```js\nawait firebase.analytics().logBeginCheckout({\n travel_class: 'business',\n});\n```\n"},"parameters":[{"id":476,"name":"params","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"See {@link analytics.BeginCheckoutEventParameters}.\n"},"type":{"type":"reference","name":"BeginCheckoutEventParameters","id":298}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":892,"character":20}]},{"id":477,"name":"logCampaignDetails","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":478,"name":"logCampaignDetails","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Log this event to supply the referral details of a re-engagement campaign.","text":"Logged event name: `campaign_details`\n\n#### Example\n\n```js\nawait firebase.analytics().logCampaignDetails({\n  source: 'email',\n  medium: 'cta_button',\n  campaign: 'newsletter',\n});\n```\n"},"parameters":[{"id":479,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.CampaignDetailsEventParameters}.\n"},"type":{"type":"reference","name":"CampaignDetailsEventParameters","id":310}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":911,"character":22}]},{"id":480,"name":"logEarnVirtualCurrency","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":481,"name":"logEarnVirtualCurrency","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Earn Virtual Currency event. This event tracks the awarding of virtual currency in your app. Log this along with\n{@link analytics.logSpendVirtualCurrency} to better understand your virtual economy.","text":"Logged event name: `earn_virtual_currency`\n\n#### Example\n\n```js\nawait firebase.analytics().logEarnVirtualCurrency({\n  virtual_currency_name: 'coins',\n  value: 100,\n});\n```\n"},"parameters":[{"id":482,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.EarnVirtualCurrencyEventParameters}.\n"},"type":{"type":"reference","name":"EarnVirtualCurrencyEventParameters","id":318}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":930,"character":26}]},{"id":483,"name":"logEcommercePurchase","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":484,"name":"logEcommercePurchase","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"E-Commerce Purchase event. This event signifies that an item was purchased by a user. This is\ndifferent from the in-app purchase event, which is reported automatically for Google Play-based apps.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `ecommerce_purchase`\n\n#### Example\n\n```js\nawait firebase.analytics().logEcommercePurchase({\n  coupon: 'BOGOFF',\n});\n```\n"},"parameters":[{"id":485,"name":"params","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"See {@link analytics.EcommercePurchaseEventParameters}.\n"},"type":{"type":"reference","name":"EcommercePurchaseEventParameters","id":321}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":950,"character":24}]},{"id":429,"name":"logEvent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":430,"name":"logEvent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Log a custom event with optional params.","text":"#### Example\n\n```js\nawait firebase.analytics().logEvent('product_view', {\n  id: '1234',\n});\n```\n\n> 100 characters is the maximum length for param key names.\n"},"parameters":[{"id":431,"name":"name","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Event name must not conflict with any Reserved Events."},"type":{"type":"intrinsic","name":"string"}},{"id":432,"name":"params","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Parameters to be sent and displayed with the event.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":433,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":434,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":435,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}]}}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":673,"character":12}]},{"id":486,"name":"logGenerateLead","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":487,"name":"logGenerateLead","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generate Lead event. Log this event when a lead has been generated in the app to understand\nthe efficacy of your install and re-engagement campaigns.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `generate_lead`\n\n#### Example\n\n```js\nawait firebase.analytics().logGenerateLead({\n  currency: 'USD',\n  value: 123,\n});\n```\n"},"parameters":[{"id":488,"name":"params","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"See {@link analytics.GenerateLeadEventParameters}.\n"},"type":{"type":"reference","name":"GenerateLeadEventParameters","id":337}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":971,"character":19}]},{"id":489,"name":"logJoinGroup","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":490,"name":"logJoinGroup","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Join Group event. Log this event when a user joins a group such as a guild, team or family.\nUse this event to analyze how popular certain groups or social features are in your app","text":"Logged event name: `join_group`\n\n#### Example\n\n```js\nawait firebase.analytics().logJoinGroup({\n  group_id: '12345',\n});\n```\n"},"parameters":[{"id":491,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.JoinGroupEventParameters}.\n"},"type":{"type":"reference","name":"JoinGroupEventParameters","id":340}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":989,"character":16}]},{"id":492,"name":"logLevelEnd","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":493,"name":"logLevelEnd","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Level End event.","text":"Logged event name: `level_end`\n\n#### Example\n\n```js\nawait firebase.analytics().logLevelEnd({\n  level: 12,\n  success: 'true'\n});\n```\n"},"parameters":[{"id":494,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.LevelEndEventParameters}.\n"},"type":{"type":"reference","name":"LevelEndEventParameters","id":342}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1007,"character":15}]},{"id":495,"name":"logLevelStart","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":496,"name":"logLevelStart","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Level Start event.","text":"Logged event name: `level_start`\n\n#### Example\n\n```js\nawait firebase.analytics().logLevelStart({\n  level: 12,\n});\n```\n"},"parameters":[{"id":497,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.LevelStartEventParameters}.\n"},"type":{"type":"reference","name":"LevelStartEventParameters","id":345}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1024,"character":17}]},{"id":498,"name":"logLevelUp","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":499,"name":"logLevelUp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Level Up event. This event signifies that a player has leveled up in your gaming app.\nIt can help you gauge the level distribution of your userbase and help you identify certain levels that are difficult to pass.","text":"Logged event name: `level_up`\n\n#### Example\n\n```js\nawait firebase.analytics().logLevelUp({\n  level: 12,\n  character: 'Snake',\n});\n```\n"},"parameters":[{"id":500,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.LevelUpEventParameters}.\n"},"type":{"type":"reference","name":"LevelUpEventParameters","id":347}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1043,"character":14}]},{"id":501,"name":"logLogin","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":502,"name":"logLogin","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Login event. Apps with a login feature can report this event to signify that a user has logged in.","text":"Logged event name: `login`\n\n#### Example\n\n```js\nawait firebase.analytics().logLogin({\n  method: 'facebook.com',\n});\n```\n"},"parameters":[{"id":503,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.LoginEventParameters}.\n"},"type":{"type":"reference","name":"LoginEventParameters","id":350}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1060,"character":12}]},{"id":504,"name":"logPresentOffer","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":505,"name":"logPresentOffer","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Present Offer event. This event signifies that the app has presented a purchase offer to a user.\nAdd this event to a funnel with the {@link analytics#logAddToCart} and {@link analytics#logEcommercePurchase}\nto gauge your conversion process.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `present_offer`\n\n#### Example\n\n```js\nawait firebase.analytics().logPresentOffer({\n  item_id: 'abcd',\n  item_name: 't-shirt',\n  item_category: 'shirts',\n  quantity: 1,\n  price: 9.99,\n});\n```\n"},"parameters":[{"id":506,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.PresentOfferEventParameters}.\n"},"type":{"type":"reference","name":"PresentOfferEventParameters","id":356}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1085,"character":19}]},{"id":507,"name":"logPurchaseRefund","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":508,"name":"logPurchaseRefund","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"E-Commerce Purchase Refund event. This event signifies that an item purchase was refunded.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `purchase_refund`\n\n#### Example\n\n```js\nawait firebase.analytics().logPurchaseRefund({\n transaction_id: 'abcd',\n});\n```\n"},"parameters":[{"id":509,"name":"params","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"See {@link analytics.PurchaseRefundEventParameters}.\n"},"type":{"type":"reference","name":"PurchaseRefundEventParameters","id":360}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1104,"character":21}]},{"id":510,"name":"logRemoveFromCart","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":511,"name":"logRemoveFromCart","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Remove from cart event.","text":"Logged event name: `remove_from_cart`\n\n#### Example\n\n```js\nawait firebase.analytics().logRemoveFromCart({\n  item_id: 'abcd',\n  item_name: 't-shirt',\n  item_category: 'shirts',\n});\n```\n"},"parameters":[{"id":512,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.RemoveFromCartEventParameters}.\n"},"type":{"type":"reference","name":"RemoveFromCartEventParameters","id":364}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1123,"character":21}]},{"id":513,"name":"logSearch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":514,"name":"logSearch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Search event. Apps that support search features can use this event to contextualize search\noperations by supplying the appropriate, corresponding parameters. This event can help you\nidentify the most popular content in your app.","text":"Logged event name: `search`\n\n#### Example\n\n```js\nawait firebase.analytics().logSearch({\n search_term: 't-shirts',\n});\n```\n"},"parameters":[{"id":515,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.SearchEventParameters}.\n"},"type":{"type":"reference","name":"SearchEventParameters","id":377}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1142,"character":13}]},{"id":516,"name":"logSelectContent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":517,"name":"logSelectContent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Select Content event. This general purpose event signifies that a user has selected some\ncontent of a certain type in an app. The content can be any object in your app. This event\ncan help you identify popular content and categories of content in your app.","text":"Logged event name: `select_content`\n\n#### Example\n\n```js\nawait firebase.analytics().logSelectContent({\n content_type: 'clothing',\n item_id: 'abcd',\n});\n```\n"},"parameters":[{"id":518,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.SelectContentEventParameters}.\n"},"type":{"type":"reference","name":"SelectContentEventParameters","id":387}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1162,"character":20}]},{"id":519,"name":"logSetCheckoutOption","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":520,"name":"logSetCheckoutOption","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Set checkout option event.","text":"Logged event name: `set_checkout_option`\n\n#### Example\n\n```js\nawait firebase.analytics().logSetCheckoutOption({\n  checkout_step: 2,\n  checkout_option: 'false',\n});\n```\n"},"parameters":[{"id":521,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.SetCheckoutOptionEventParameters}.\n"},"type":{"type":"reference","name":"SetCheckoutOptionEventParameters","id":390}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1180,"character":24}]},{"id":522,"name":"logShare","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":523,"name":"logShare","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Share event. Apps with social features can log the Share event to identify the most viral content.","text":"Logged event name: `share`\n\n#### Example\n\n```js\nawait firebase.analytics().logShare({\n  content_type: 't-shirts',\n  item_id: '12345',\n  method: 'twitter.com',\n});\n```\n"},"parameters":[{"id":524,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.ShareEventParameters}.\n"},"type":{"type":"reference","name":"ShareEventParameters","id":393}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1199,"character":12}]},{"id":525,"name":"logSignUp","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":526,"name":"logSignUp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sign Up event. This event indicates that a user has signed up for an account in your app.\nThe parameter signifies the method by which the user signed up. Use this event to understand\nthe different behaviors between logged in and logged out users.","text":"Logged event name: `sign_up`\n\n#### Example\n\n```js\nawait firebase.analytics().logSignUp({\n  method: 'facebook.com',\n});\n```\n"},"parameters":[{"id":527,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.SignUpEventParameters}.\n"},"type":{"type":"reference","name":"SignUpEventParameters","id":396}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1218,"character":13}]},{"id":528,"name":"logSpendVirtualCurrency","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":529,"name":"logSpendVirtualCurrency","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Spend Virtual Currency event. This event tracks the sale of virtual goods in your app and can\nhelp you identify which virtual goods are the most popular objects of purchase.","text":"Logged event name: `spend_virtual_currency`\n\n#### Example\n\n```js\nawait firebase.analytics().logSpendVirtualCurrency({\n  item_name: 'battle_pass',\n  virtual_currency_name: 'coins',\n  value: 100,\n});\n```\n"},"parameters":[{"id":530,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.SpendVirtualCurrencyEventParameters}.\n"},"type":{"type":"reference","name":"SpendVirtualCurrencyEventParameters","id":398}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1238,"character":27}]},{"id":531,"name":"logTutorialBegin","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":532,"name":"logTutorialBegin","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Tutorial Begin event. This event signifies the start of the on-boarding process in your app.\nUse this in a funnel with {@link analytics#logTutorialComplete} to understand how many users\ncomplete this process and move on to the full app experience.","text":"Logged event name: `tutorial_begin`\n\n#### Example\n\n```js\nawait firebase.analytics().logTutorialBegin();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1253,"character":20}]},{"id":533,"name":"logTutorialComplete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":534,"name":"logTutorialComplete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Tutorial End event. Use this event to signify the user's completion of your app's on-boarding process.\nAdd this to a funnel with {@link analytics#logTutorialBegin} to understand how many users\ncomplete this process and move on to the full app experience.","text":"Logged event name: `tutorial_complete`\n\n#### Example\n\n```js\nawait firebase.analytics().logTutorialComplete();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1268,"character":23}]},{"id":535,"name":"logUnlockAchievement","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":536,"name":"logUnlockAchievement","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unlock Achievement event. Log this event when the user has unlocked an achievement in your game.\nSince achievements generally represent the breadth of a gaming experience, this event can help\nyou understand how many users are experiencing all that your game has to offer.","text":"Logged event name: `unlock_achievement`\n\n#### Example\n\n```js\nawait firebase.analytics().logUnlockAchievement({\n  achievement_id: '12345',\n});\n```\n"},"parameters":[{"id":537,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.UnlockAchievementEventParameters}.\n"},"type":{"type":"reference","name":"UnlockAchievementEventParameters","id":402}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1287,"character":24}]},{"id":538,"name":"logViewItem","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":539,"name":"logViewItem","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"View Item event. This event signifies that some content was shown to the user. This content\nmay be a product, a screen or just a simple image or text. Use the appropriate parameters\nto contextualize the event. Use this event to discover the most popular items viewed in your app.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `view_item`\n\n#### Example\n\n```js\nawait firebase.analytics().logViewItem({\n item_id: 'abcd',\n item_name: 't-shirt',\n item_category: 'shirts',\n});\n```\n"},"parameters":[{"id":540,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.ViewItemEventParameters}.\n"},"type":{"type":"reference","name":"ViewItemEventParameters","id":404}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1310,"character":15}]},{"id":541,"name":"logViewItemList","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":542,"name":"logViewItemList","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"View Item List event. Log this event when the user has been presented with a list of items of a certain category.","text":"Logged event name: `view_item_list`\n\n#### Example\n\n```js\nawait firebase.analytics().logViewItemList({\n  item_category: 't-shirts',\n});\n```\n"},"parameters":[{"id":543,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.ViewItemListEventParameters}.\n"},"type":{"type":"reference","name":"ViewItemListEventParameters","id":423}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1327,"character":19}]},{"id":544,"name":"logViewSearchResults","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":545,"name":"logViewSearchResults","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"View Search Results event. Log this event when the user has been presented with the results of a search.","text":"Logged event name: `view_search_results`\n\n#### Example\n\n```js\nawait firebase.analytics().logViewSearchResults({\n  search_term: 'clothing',\n});\n```\n"},"parameters":[{"id":546,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.ViewSearchResults}.\n"},"type":{"type":"reference","name":"ViewSearchResults","id":425}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1344,"character":24}]},{"id":462,"name":"resetAnalyticsData","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":463,"name":"resetAnalyticsData","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Clears all analytics data for this instance from the device and resets the app instance ID.","text":"#### Example\n\n```js\nawait firebase.analytics().resetAnalyticsData();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":796,"character":22}]},{"id":436,"name":"setAnalyticsCollectionEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":437,"name":"setAnalyticsCollectionEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"If true, allows the device to collect analytical data and send it to\nFirebase. Useful for GDPR.","text":"#### Example\n\n```js\n// Disable collection\nawait firebase.analytics().setAnalyticsCollectionEnabled(false);\n```\n"},"parameters":[{"id":438,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A boolean value representing whether Analytics collection is enabled or disabled. Analytics collection is enabled by default.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":688,"character":33}]},{"id":439,"name":"setCurrentScreen","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":440,"name":"setCurrentScreen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the current screen name.","text":"#### Example\n\n```js\nawait firebase.analytics().setCurrentScreen('ProductScreen', 'ProductScreen');\n```\n\n> Whilst screenClassOverride is optional, it is recommended it is\nalways sent as your current class name. For example on Android it will always\nshow as 'MainActivity' if you do not specify it.\n"},"parameters":[{"id":441,"name":"screenName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A screen name, e.g. Product."},"type":{"type":"intrinsic","name":"string"}},{"id":442,"name":"screenClassOverride","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"On Android, React Native runs in a single activity called\n'MainActivity'. Setting this parameter overrides the default name shown on logs.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":707,"character":20}]},{"id":443,"name":"setMinimumSessionDuration","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":444,"name":"setMinimumSessionDuration","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the minimum engagement time required before starting a session.","text":"#### Example\n\n```js\n// 20 seconds\nawait firebase.analytics().setMinimumSessionDuration(20000);\n```\n"},"parameters":[{"id":445,"name":"milliseconds","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The default value is 10000 (10 seconds).\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":721,"character":29}]},{"id":446,"name":"setSessionTimeoutDuration","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":447,"name":"setSessionTimeoutDuration","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the duration of inactivity that terminates the current session.","text":"#### Example\n\n```js\n// 20 minutes\nawait firebase.analytics().setMinimumSessionDuration(900000);\n```\n"},"parameters":[{"id":448,"name":"milliseconds","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The default value is 1800000 (30 minutes).\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":735,"character":29}]},{"id":449,"name":"setUserId","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":450,"name":"setUserId","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gives a user a unique identification.","text":"#### Example\n\n```js\n// Set User\nawait firebase.analytics().setUserId('123456789');\n// Remove User\nawait firebase.analytics().setUserId(null);\n```\n"},"parameters":[{"id":451,"name":"id","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Set to null to remove a previously assigned ID from analytics\nevents\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":752,"character":13}]},{"id":456,"name":"setUserProperties","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":457,"name":"setUserProperties","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets multiple key/value pairs of data on the current user. Each Firebase project can have up to 25 uniquely named (case-sensitive) user properties.","text":"#### Example\n\n```js\nawait firebase.analytics().setUserProperties({\n  account_type: 'gold',\n  account_name: 'Gold Badge',\n});\n```\n\n> When you set user properties, be sure to never include personally identifiable information such as names, social security numbers, or email addresses, even in hashed form.\n","tags":[{"tag":"react-native-firebase","text":""}]},"parameters":[{"id":458,"name":"properties","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Set a property value to null to remove it.\n"},"type":{"type":"reflection","declaration":{"id":459,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":460,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":461,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":785,"character":33}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":785,"character":21}]},{"id":452,"name":"setUserProperty","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":453,"name":"setUserProperty","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a key/value pair of data on the current user. Each Firebase project can have up to 25 uniquely named (case-sensitive) user properties.","text":"#### Example\n\n```js\nawait firebase.analytics().setUserProperty('account_type', 'gold');\n```\n"},"parameters":[{"id":454,"name":"name","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A user property identifier."},"type":{"type":"intrinsic","name":"string"}},{"id":455,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Set to null to remove a previously assigned ID from analytics events.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":766,"character":19}]}],"groups":[{"title":"Properties","kind":1024,"children":[547]},{"title":"Methods","kind":2048,"children":[464,466,469,472,474,477,480,483,429,486,489,492,495,498,501,504,507,510,513,516,519,522,525,528,531,533,535,538,541,544,462,436,439,443,446,449,456,452]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":656,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":276,"name":"AddToCartEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":283,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":83,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":286,"name":"destination","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel destination. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":95,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":288,"name":"end_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":103,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":279,"name":"item_category","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item category."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":65,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":277,"name":"item_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":57,"character":11}],"type":{"type":"intrinsic","name":"string"}},{"id":285,"name":"item_location_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Google [Place ID](https://developers.google.com/places/place-id) that corresponds to the associated item (String). Alternatively, you can supply your own custom Location ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":91,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":278,"name":"item_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item name."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":61,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":284,"name":"origin","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel origin. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":87,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":281,"name":"price","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase price."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":73,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":280,"name":"quantity","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Purchase quantity."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":69,"character":12}],"type":{"type":"intrinsic","name":"number"}},{"id":287,"name":"start_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":99,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":282,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":79,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[283,286,288,279,277,285,278,284,281,280,287,282]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":53,"character":43}]},{"id":289,"name":"AddToWishlistEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":296,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":136,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":292,"name":"item_category","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item category."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":118,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":290,"name":"item_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":110,"character":11}],"type":{"type":"intrinsic","name":"string"}},{"id":297,"name":"item_location_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Google [Place ID](https://developers.google.com/places/place-id) that corresponds to the associated item (String). Alternatively, you can supply your own custom Location ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":140,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":291,"name":"item_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item name."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":114,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":294,"name":"price","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase price."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":126,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":293,"name":"quantity","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Purchase quantity."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":122,"character":12}],"type":{"type":"intrinsic","name":"number"}},{"id":295,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":132,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[296,292,290,297,291,294,293,295]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":106,"character":47}]},{"id":298,"name":"BeginCheckoutEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":300,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":153,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":306,"name":"destination","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel destination. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":177,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":308,"name":"end_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":185,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":302,"name":"number_of_nights","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of nights staying at hotel."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":161,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":304,"name":"number_of_passengers","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of passengers traveling."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":169,"character":24}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":303,"name":"number_of_rooms","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of rooms for travel events."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":165,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":305,"name":"origin","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel origin. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":173,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":307,"name":"start_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":181,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":301,"name":"transaction_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A single ID for a ecommerce group transaction."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":157,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":309,"name":"travel_class","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Travel class. E.g. `business`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":189,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":299,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":149,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[300,306,308,302,304,303,305,307,301,309,299]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":143,"character":47}]},{"id":310,"name":"CampaignDetailsEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":316,"name":"aclid","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A campaign detail click ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":216,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":313,"name":"campaign","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":" Used for keyword analysis to identify a specific product promotion or strategic campaign."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":204,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":315,"name":"content","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Used for A/B testing and content-targeted ads to differentiate ads or links that point to the same URL."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":212,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":317,"name":"cp1","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":217,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":312,"name":"medium","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Used to identify a medium such as email or cost-per-click (cpc)."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":200,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":311,"name":"source","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Used to identify a search engine, newsletter, or other source."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":196,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":314,"name":"term","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Used with paid search to supply the keywords for ads."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":208,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[316,313,315,317,312,311,314]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":192,"character":49}]},{"id":318,"name":"EarnVirtualCurrencyEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":320,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":229,"character":9}],"type":{"type":"intrinsic","name":"number"}},{"id":319,"name":"virtual_currency_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Name of virtual currency type. E.g. `gems`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":224,"character":25}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[320,319]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":220,"character":53}]},{"id":321,"name":"EcommercePurchaseEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":327,"name":"coupon","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Coupon code for a purchasable item."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":258,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":322,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":236,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":333,"name":"destination","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel destination. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":282,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":335,"name":"end_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":290,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":328,"name":"location","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Google [Place ID](https://developers.google.com/places/place-id) that corresponds to the associated event. Alternatively, you can supply your own custom Location ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":262,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":329,"name":"number_of_nights","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of nights staying at hotel."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":266,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":331,"name":"number_of_passengers","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of passengers traveling."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":274,"character":24}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":330,"name":"number_of_rooms","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of rooms for travel events."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":270,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":332,"name":"origin","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel origin. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":278,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":326,"name":"shipping","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Shipping cost."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":254,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":334,"name":"start_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":286,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":325,"name":"tax","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Tax amount."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":250,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":324,"name":"transaction_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A single ID for a ecommerce group transaction."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":246,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":336,"name":"travel_class","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Travel class. E.g. `business`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":294,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":323,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":242,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[327,322,333,335,328,329,331,330,332,326,334,325,324,336,323]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":232,"character":51}]},{"id":337,"name":"GenerateLeadEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":338,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":301,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":339,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":307,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[338,339]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":297,"character":46}]},{"id":340,"name":"JoinGroupEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":341,"name":"group_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Group/clan/guild id."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":314,"character":12}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[341]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":310,"character":43}]},{"id":342,"name":"LevelEndEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":343,"name":"level","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Level in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":321,"character":9}],"type":{"type":"intrinsic","name":"number"}},{"id":344,"name":"success","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The result of an operation."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":325,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[343,344]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":317,"character":42}]},{"id":345,"name":"LevelStartEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":346,"name":"level","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Level in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":332,"character":9}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[346]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":328,"character":44}]},{"id":347,"name":"LevelUpEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":349,"name":"character","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Character used in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":343,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":348,"name":"level","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Level in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":339,"character":9}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[349,348]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":335,"character":41}]},{"id":350,"name":"LoginEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":351,"name":"method","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The login method. E.g. `facebook.com`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":350,"character":10}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[351]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":346,"character":39}]},{"id":352,"name":"PostScoreEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":355,"name":"character","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Character used in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":365,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":354,"name":"level","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Level in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":361,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":353,"name":"score","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Score in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":357,"character":9}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[355,354,353]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":353,"character":43}]},{"id":356,"name":"PresentOfferEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":359,"name":"character","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Character used in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":380,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":358,"name":"level","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Level in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":376,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":357,"name":"score","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Score in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":372,"character":9}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[359,358,357]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":368,"character":46}]},{"id":360,"name":"PurchaseRefundEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":361,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":387,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":363,"name":"transaction_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A single ID for a ecommerce group transaction."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":397,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":362,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":393,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[361,363,362]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":383,"character":48}]},{"id":364,"name":"RemoveFromCartEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":371,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":430,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":376,"name":"destination","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel destination. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":450,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":374,"name":"end_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":442,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":367,"name":"item_category","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item category."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":412,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":365,"name":"item_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":404,"character":11}],"type":{"type":"intrinsic","name":"string"}},{"id":372,"name":"item_location_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Google [Place ID](https://developers.google.com/places/place-id) that corresponds to the associated item (String). Alternatively, you can supply your own custom Location ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":434,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":366,"name":"item_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item name."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":408,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":375,"name":"origin","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel origin. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":446,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":370,"name":"price","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase price."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":426,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":368,"name":"quantity","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase quantity."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":416,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":373,"name":"start_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":438,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":369,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":422,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[371,376,374,367,365,372,366,375,370,368,373,369]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":400,"character":48}]},{"id":377,"name":"SearchEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":383,"name":"destination","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel destination. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":474,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":385,"name":"end_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":482,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":379,"name":"number_of_nights","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of nights staying at hotel."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":458,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":381,"name":"number_of_passengers","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of passengers traveling."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":466,"character":24}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":380,"name":"number_of_rooms","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of rooms for travel events."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":462,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":382,"name":"origin","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel origin. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":470,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":378,"name":"search_term","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":454,"character":15}],"type":{"type":"intrinsic","name":"string"}},{"id":384,"name":"start_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":478,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":386,"name":"travel_class","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Travel class. E.g. `business`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":486,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[383,385,379,381,380,382,378,384,386]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":453,"character":40}]},{"id":387,"name":"SelectContentEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":388,"name":"content_type","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":490,"character":16}],"type":{"type":"intrinsic","name":"string"}},{"id":389,"name":"item_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":494,"character":11}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[388,389]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":489,"character":47}]},{"id":390,"name":"SetCheckoutOptionEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":392,"name":"checkout_option","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Some option on a step in an ecommerce flow."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":505,"character":19}],"type":{"type":"intrinsic","name":"string"}},{"id":391,"name":"checkout_step","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The checkout step (1..N)."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":501,"character":17}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[392,391]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":497,"character":51}]},{"id":393,"name":"ShareEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":394,"name":"content_type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Type of content selected."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":512,"character":16}],"type":{"type":"intrinsic","name":"string"}},{"id":395,"name":"item_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":516,"character":11}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[394,395]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":508,"character":39}]},{"id":396,"name":"SignUpEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":397,"name":"method","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A particular approach used in an operation; for example, \"facebook\" or \"email\" in the context of a sign_up or login event."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":523,"character":10}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[397]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":519,"character":40}]},{"id":398,"name":"SpendVirtualCurrencyEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":399,"name":"item_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item name."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":530,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":401,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":540,"character":9}],"type":{"type":"intrinsic","name":"number"}},{"id":400,"name":"virtual_currency_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Name of virtual currency type. E.g. `gems`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":534,"character":25}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[399,401,400]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":526,"character":54}]},{"id":427,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":641,"character":26}]},{"id":402,"name":"UnlockAchievementEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":403,"name":"achievement_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Game achievement ID (String)."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":547,"character":18}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[403]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":543,"character":51}]},{"id":404,"name":"ViewItemEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":411,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":578,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":418,"name":"destination","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel destination. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":608,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":420,"name":"end_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":616,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":413,"name":"flight_number","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight number for travel events."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":588,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":407,"name":"item_category","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item category."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":562,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":405,"name":"item_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":554,"character":11}],"type":{"type":"intrinsic","name":"string"}},{"id":408,"name":"item_location_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Google [Place ID](https://developers.google.com/places/place-id) that corresponds to the associated item (String). Alternatively, you can supply your own custom Location ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":566,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":406,"name":"item_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item name."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":558,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":415,"name":"number_of_nights","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of nights staying at hotel."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":596,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":414,"name":"number_of_passengers","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of passengers traveling."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":592,"character":24}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":416,"name":"number_of_rooms","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of rooms for travel events."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":600,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":417,"name":"origin","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel origin. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":604,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":409,"name":"price","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase price."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":570,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":410,"name":"quantity","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase quantity."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":574,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":421,"name":"search_term","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The search string/keywords used."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":620,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":419,"name":"start_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":612,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":422,"name":"travel_class","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Travel class. E.g. `business`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":624,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":412,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":584,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[411,418,420,413,407,405,408,406,415,414,416,417,409,410,421,419,422,412]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":550,"character":42}]},{"id":423,"name":"ViewItemListEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":424,"name":"item_category","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item category."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":631,"character":17}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[424]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":627,"character":46}]},{"id":425,"name":"ViewSearchResults","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":426,"name":"search_term","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The search string/keywords used."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":638,"character":15}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[426]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":634,"character":36}]}],"groups":[{"title":"Classes","kind":128,"children":[428]},{"title":"Interfaces","kind":256,"children":[276,289,298,310,318,321,337,340,342,345,347,350,352,356,360,364,377,387,390,393,396,398,427,402,404,423,425]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":50,"character":39}]},{"id":556,"name":"FirebaseAuthTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Authentication package for React Native.","text":"#### Example: Access the firebase export from the `auth` package:\n\n```js\nimport { firebase } from '@react-native-firebase/auth';\n\n// firebase.auth().X\n```\n\n#### Example: Using the default export from the `auth` package:\n\n```js\nimport auth from '@react-native-firebase/auth';\n\n// auth().X\n```\n\n#### Example: Using the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/auth';\n\n// firebase.auth().X\n```\nTODO @salakar @ehesp missing auth providers (PhoneAuthProvider, Facebook etc)\n","tags":[{"tag":"firebase","text":"auth\n"}]},"children":[{"id":746,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Authentication service is available for the default app or a given app.","text":"#### Example 1\n\nGet the auth instance for the **default app**:\n\n```js\nconst authForDefaultApp = firebase.auth();\n```\n\n#### Example 2\n\nGet the auth instance for a **secondary app**:\n\n```js\nconst otherApp = firebase.app('otherApp');\nconst authForOtherApp = firebase.auth(otherApp);\n```\n\nTODO @salakar missing updateCurrentUser\n"},"children":[{"id":829,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":752,"name":"currentUser","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the currently signed-in user (or null if no user signed in). See the User interface documentation for detailed usage.","text":"#### Example\n\n```js\nconst user = firebase.auth().currentUser;\n```\n\n> It is recommended to use {@link auth#onAuthStateChanged} to track whether the user is currently signed in.\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1209,"character":15}],"type":{"type":"union","types":[{"type":"reference","name":"User","id":699},{"type":"intrinsic","name":"null"}]}},{"id":751,"name":"settings","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the current `AuthSettings`."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1196,"character":12}],"type":{"type":"reference","name":"AuthSettings","id":693}},{"id":747,"name":"languageCode","kind":262144,"kindString":"Accessor","flags":{"isExported":true},"comment":{"shortText":"Gets the current language code.\nSets the language code.","text":"#### Example\n\n```js\nconst language = firebase.auth().languageCode;\n```\n\n#### Example\n\n```js\n// Set language to French\nfirebase.auth().languageCode = 'fr';\n```\n"},"getSignature":[{"id":748,"name":"__get","kind":524288,"kindString":"Get signature","flags":{},"comment":{"shortText":"Gets the current language code.","text":"#### Example\n\n```js\nconst language = firebase.auth().languageCode;\n```\n"},"type":{"type":"intrinsic","name":"string"}}],"setSignature":[{"id":749,"name":"__set","kind":1048576,"kindString":"Set signature","flags":{},"comment":{"shortText":"Sets the language code.","text":"#### Example\n\n```js\n// Set language to French\nfirebase.auth().languageCode = 'fr';\n```\n"},"parameters":[{"id":750,"name":"code","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"An ISO language code.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1177,"character":20},{"fileName":"packages/auth/lib/index.d.ts","line":1191,"character":20}]},{"id":814,"name":"applyActionCode","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":815,"name":"applyActionCode","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Applies a verification code sent to the user by email or other out-of-band mechanism.","text":"#### Example\n\n```js\nawait firebase.auth().applyActionCode('ABCD');\n```\n","tags":[{"tag":"error","text":"auth/expired-action-code Thrown if the action code has expired."},{"tag":"error","text":"auth/invalid-action-code Thrown if the action code is invalid. This can happen if the code is malformed or has already been used."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given action code has been disabled."},{"tag":"error","text":"auth/user-not-found Thrown if there is no user corresponding to the action code. This may have happened if the user was deleted between when the action code was issued and when this method was called."}]},"parameters":[{"id":816,"name":"code","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A verification code sent to the user.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1542,"character":19}]},{"id":817,"name":"checkActionCode","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":818,"name":"checkActionCode","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Checks a verification code sent to the user by email or other out-of-band mechanism.","text":"#### Example\n\n```js\nconst actionCodeInfo = await firebase.auth().checkActionCode('ABCD');\nconsole.log('Action code operation: ', actionCodeInfo.operation);\n```\n","tags":[{"tag":"error","text":"auth/expired-action-code Thrown if the action code has expired."},{"tag":"error","text":"auth/invalid-action-code Thrown if the action code is invalid. This can happen if the code is malformed or has already been used."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given action code has been disabled."},{"tag":"error","text":"auth/user-not-found Thrown if there is no user corresponding to the action code. This may have happened if the user was deleted between when the action code was issued and when this method was called."}]},"parameters":[{"id":819,"name":"code","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A verification code sent to the user.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"ActionCodeInfo","id":640}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1560,"character":19}]},{"id":810,"name":"confirmPasswordReset","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":811,"name":"confirmPasswordReset","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Completes the password reset process with the confirmation code and new password, via\n{@link auth#sendPasswordResetEmail}.","text":"#### Example\n\n```js\nawait firebase.auth().confirmPasswordReset('ABCD', '1234567');\n```\n","tags":[{"tag":"error","text":"auth/expired-action-code Thrown if the password reset code has expired."},{"tag":"error","text":"auth/invalid-action-code Thrown if the password reset code is invalid. This can happen if the code is malformed or has already been used."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given password reset code has been disabled."},{"tag":"error","text":"auth/user-not-found Thrown if there is no user corresponding to the password reset code. This may have happened if the user was deleted between when the code was issued and when this method was called."},{"tag":"error","text":"auth/weak-password Thrown if the new password is not strong enough."}]},"parameters":[{"id":812,"name":"code","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The code from the password reset email."},"type":{"type":"intrinsic","name":"string"}},{"id":813,"name":"newPassword","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new password.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1525,"character":24}]},{"id":781,"name":"createUserWithEmailAndPassword","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":782,"name":"createUserWithEmailAndPassword","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new user with an email and password.","text":"This method also signs the user in once the account has been created.\n\n#### Example\n\n```js\nconst userCredential = await firebase.auth().createUserWithEmailAndPassword('joe.bloggs@example.com', '123456');\n```\n","tags":[{"tag":"error","text":"auth/email-already-in-use Thrown if there already exists an account with the given email address."},{"tag":"error","text":"auth/invalid-email Thrown if the email address is not valid."},{"tag":"error","text":"auth/operation-not-allowed Thrown if email/password accounts are not enabled. Enable email/password accounts in the Firebase Console, under the Auth tab."},{"tag":"error","text":"auth/weak-password Thrown if the password is not strong enough."}]},"parameters":[{"id":783,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users email address."},"type":{"type":"intrinsic","name":"string"}},{"id":784,"name":"password","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users password.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1372,"character":34}]},{"id":820,"name":"fetchSignInMethodsForEmail","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":821,"name":"fetchSignInMethodsForEmail","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a list of authentication methods that can be used to sign in a given user (identified by its main email address).","text":"#### Example\n\n```js\nconst methods = await firebase.auth().fetchSignInMethodsForEmail('joe.bloggs@example.com');\n\nmethods.forEach((method) => {\n  console.log(method);\n});\n```\n","tags":[{"tag":"error","text":"auth/invalid-email Thrown if the email address is not valid."}]},"parameters":[{"id":822,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users email address.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1578,"character":30}]},{"id":803,"name":"isSignInWithEmailLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":804,"name":"isSignInWithEmailLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns whether the user signed in with a given email link.","text":"#### Example\n\n```js\nconst signedInWithLink = firebase.auth().isSignInWithEmailLink(link);\n```\n"},"parameters":[{"id":805,"name":"emailLink","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The email link to check whether the user signed in with it.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1488,"character":25}]},{"id":753,"name":"onAuthStateChanged","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":754,"name":"onAuthStateChanged","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen for changes in the users auth state (logging in and out).\nThis method returns a unsubscribe function to stop listening to events.\nAlways ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use.","text":"#### Example\n\n```js\nconst unsubscribe = firebase.auth().onAuthStateChanged((user) => {\n  if (user) {\n    // Signed in\n  } else {\n    // Signed out\n  }\n});\n\n// Unsubscribe from further state changes\nunsubscribe();\n```\n"},"parameters":[{"id":755,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A listener function which triggers when auth state changed (for example signing out).\n"},"type":{"type":"reference","name":"AuthListenerCallback","id":830}}],"type":{"type":"reflection","declaration":{"id":756,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":757,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1233,"character":55}]}}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1233,"character":22}]},{"id":758,"name":"onIdTokenChanged","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":759,"name":"onIdTokenChanged","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen for changes in ID token.\nThis method returns a unsubscribe function to stop listening to events.\nAlways ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use.","text":"#### Example\n\n```js\nconst unsubscribe = firebase.auth().onIdTokenChanged((user) => {\n  if (user) {\n    // User is signed in or token was refreshed.\n  }\n});\n\n// Unsubscribe from further state changes\nunsubscribe();\n```\n"},"parameters":[{"id":760,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A listener function which triggers when the users ID token changes.\n"},"type":{"type":"reference","name":"AuthListenerCallback","id":830}}],"type":{"type":"reflection","declaration":{"id":761,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":762,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1255,"character":53}]}}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1255,"character":20}]},{"id":763,"name":"onUserChanged","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":764,"name":"onUserChanged","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Adds a listener to observe changes to the User object. This is a superset of everything from\n{@link auth#onAuthStateChanged}, {@link auth#onIdTokenChanged} and user changes. The goal of this\nmethod is to provide easier listening to all user changes, such as when credentials are\nlinked and unlinked, without manually having to call {@link auth.User#reload}.","text":"#### Example\n\n```js\nconst unsubscribe = firebase.auth().onUserChanged((user) => {\n  if (user) {\n    // User is signed in or token was refreshed.\n  }\n});\n\n// Unsubscribe from further state changes\nunsubscribe();\n```\n\n> This is an experimental feature and is only part of React Native Firebase.\n","tags":[{"tag":"react-native-firebase","text":""}]},"parameters":[{"id":765,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A listener function which triggers when the users data changes.\n"},"type":{"type":"reference","name":"AuthListenerCallback","id":830}}],"type":{"type":"reflection","declaration":{"id":766,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":767,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1281,"character":50}]}}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1281,"character":17}]},{"id":795,"name":"sendPasswordResetEmail","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":796,"name":"sendPasswordResetEmail","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends a password reset email to the given email address.\nUnlike the web SDK, the email will contain a password reset link rather than a code.","text":"#### Example\n\n```js\nawait firebase.auth().sendPasswordResetEmail('joe.bloggs@example.com');\n```\n","tags":[{"tag":"error","text":"auth/invalid-email Thrown if the email address is not valid."},{"tag":"error","text":"auth/missing-android-pkg-name An Android package name must be provided if the Android app is required to be installed."},{"tag":"error","text":"auth/missing-continue-uri A continue URL must be provided in the request."},{"tag":"error","text":"auth/missing-ios-bundle-id An iOS Bundle ID must be provided if an App Store ID is provided."},{"tag":"error","text":"auth/invalid-continue-uri The continue URL provided in the request is invalid."},{"tag":"error","text":"auth/unauthorized-continue-uri The domain of the continue URL is not whitelisted. Whitelist the domain in the Firebase console."},{"tag":"error","text":"auth/user-not-found Thrown if there is no user corresponding to the email address."}]},"parameters":[{"id":797,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users email address."},"type":{"type":"intrinsic","name":"string"}},{"id":798,"name":"actionCodeSettings","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Additional settings to be set before sending the reset email.\n"},"type":{"type":"reference","name":"ActionCodeSettings","id":645}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1454,"character":26}]},{"id":799,"name":"sendSignInLinkToEmail","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":800,"name":"sendSignInLinkToEmail","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends a sign in link to the user.","text":"#### Example\n\n```js\nawait firebase.auth().sendSignInLinkToEmail('joe.bloggs@example.com');\n```\n","tags":[{"tag":"error","text":"auth/argument-error Thrown if handleCodeInApp is false."},{"tag":"error","text":"auth/invalid-email Thrown if the email address is not valid."},{"tag":"error","text":"auth/missing-android-pkg-name An Android package name must be provided if the Android app is required to be installed."},{"tag":"error","text":"auth/missing-continue-uri A continue URL must be provided in the request."},{"tag":"error","text":"auth/missing-ios-bundle-id An iOS Bundle ID must be provided if an App Store ID is provided."},{"tag":"error","text":"auth/invalid-continue-uri The continue URL provided in the request is invalid."},{"tag":"error","text":"auth/unauthorized-continue-uri The domain of the continue URL is not whitelisted. Whitelist the domain in the Firebase console."}]},"parameters":[{"id":801,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users email address."},"type":{"type":"intrinsic","name":"string"}},{"id":802,"name":"actionCodeSettings","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The action code settings. The action code settings which provides Firebase with instructions on how to construct the email link. This includes the sign in completion URL or the deep link for mobile redirects, the mobile apps to use when the sign-in link is opened on an Android or iOS device. Mobile app redirects will only be applicable if the developer configures and accepts the Firebase Dynamic Links terms of condition. The Android package name and iOS bundle ID will be respected only if they are configured in the same Firebase Auth project used.\n"},"type":{"type":"reference","name":"ActionCodeSettings","id":645}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1475,"character":25}]},{"id":770,"name":"signInAnonymously","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":771,"name":"signInAnonymously","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sign in a user anonymously. If the user has already signed in, that user will be returned.","text":"#### Example\n\n```js\nconst userCredential = await firebase.auth().signInAnonymously();\n```\n","tags":[{"tag":"error","text":"auth/operation-not-allowed Thrown if anonymous accounts are not enabled. Enable anonymous accounts in the Firebase Console, under the Auth tab.\n"}]},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1308,"character":21}]},{"id":792,"name":"signInWithCredential","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":793,"name":"signInWithCredential","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Signs the user in with a generated credential.","text":"#### Example\n\n```js\n// Generate a Firebase credential\nconst credential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook');\n// Sign the user in with the credential\nconst userCredential = await firebase.auth().signInWithCredential(credential);\n```\n","tags":[{"tag":"error","text":"auth/account-exists-with-different-credential Thrown if there already exists an account with the email address asserted by the credential."},{"tag":"error","text":"auth/invalid-credential Thrown if the credential is malformed or has expired."},{"tag":"error","text":"auth/operation-not-allowed Thrown if the type of account corresponding to the credential is not enabled. Enable the account type in the Firebase Console, under the Auth tab."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given credential has been disabled."},{"tag":"error","text":"auth/user-not-found Thrown if signing in with a credential from firebase.auth.EmailAuthProvider.credential and there is no user corresponding to the given email."},{"tag":"error","text":"auth/wrong-password Thrown if signing in with a credential from firebase.auth.EmailAuthProvider.credential and the password is invalid for the given email, or if the account corresponding to the email does not have a password set."},{"tag":"error","text":"auth/invalid-verification-code Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification code of the credential is not valid."},{"tag":"error","text":"auth/invalid-verification-id Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid."}]},"parameters":[{"id":794,"name":"credential","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A generated `AuthCredential`, for example from social auth.\n"},"type":{"type":"reference","name":"AuthCredential","id":557}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1432,"character":24}]},{"id":789,"name":"signInWithCustomToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":790,"name":"signInWithCustomToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Signs a user in with a custom token.","text":"#### Example\n\n```js\n// Create a custom token via the Firebase Admin SDK.\nconst token = await firebase.auth().createCustomToken(uid, customClaims);\n...\n// Use the token on the device to sign in.\nconst userCredential = await firebase.auth().signInWithCustomToken(token);\n```\n","tags":[{"tag":"error","text":"auth/custom-token-mismatch Thrown if the custom token is for a different Firebase App."},{"tag":"error","text":"auth/invalid-custom-token Thrown if the custom token format is incorrect."}]},"parameters":[{"id":791,"name":"customToken","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A custom token generated from the Firebase Admin SDK.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1408,"character":25}]},{"id":785,"name":"signInWithEmailAndPassword","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":786,"name":"signInWithEmailAndPassword","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Signs a user in with an email and password.","text":"#### Example\n\n```js\nconst userCredential = await firebase.auth().signInWithEmailAndPassword('joe.bloggs@example.com', '123456');\n````","tags":[{"tag":"error","text":"auth/invalid-email Thrown if the email address is not valid."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given email has been disabled."},{"tag":"error","text":"auth/user-not-found Thrown if there is no user corresponding to the given email."},{"tag":"error","text":"auth/wrong-password Thrown if the password is invalid for the given email, or the account corresponding to the email does not have a password set."}]},"parameters":[{"id":787,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users email address."},"type":{"type":"intrinsic","name":"string"}},{"id":788,"name":"password","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users password.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1389,"character":30}]},{"id":806,"name":"signInWithEmailLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":807,"name":"signInWithEmailLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Signs the user in with an email link.","text":"#### Example\n\n```js\nconst userCredential = await firebase.auth().signInWithEmailLink('joe.bloggs@example.com', link);\n```\n","tags":[{"tag":"error","text":"auth/expired-action-code Thrown if OTP in email link expires."},{"tag":"error","text":"auth/invalid-email Thrown if the email address is not valid."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given email has been disabled."}]},"parameters":[{"id":808,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users email to sign in with."},"type":{"type":"intrinsic","name":"string"}},{"id":809,"name":"emailLink","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An email link.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1505,"character":23}]},{"id":772,"name":"signInWithPhoneNumber","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":773,"name":"signInWithPhoneNumber","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Signs in the user using their phone number.","text":"#### Example\n\n```js\n// Force a new message to be sent\nconst result = await firebase.auth().signInWithPhoneNumber('#4423456789', true);\n```\n","tags":[{"tag":"error","text":"auth/invalid-phone-number Thrown if the phone number has an invalid format."},{"tag":"error","text":"auth/missing-phone-number Thrown if the phone number is missing."},{"tag":"error","text":"auth/quota-exceeded Thrown if the SMS quota for the Firebase project has been exceeded."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given phone number has been disabled."},{"tag":"error","text":"auth/operation-not-allowed Thrown if you have not enabled the provider in the Firebase Console. Go to the Firebase Console for your project, in the Auth section and the Sign in Method tab and configure the provider."}]},"parameters":[{"id":774,"name":"phoneNumber","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The devices phone number."},"type":{"type":"intrinsic","name":"string"}},{"id":775,"name":"forceResend","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Forces a new message to be sent if it was already recently sent.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"ConfirmationResult","id":628}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1328,"character":25}]},{"id":768,"name":"signOut","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":769,"name":"signOut","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Signs the user out.","text":"Triggers the {@link auth#onAuthStateChanged} listener.\n\n#### Example\n\n```js\nawait firebase.auth().signOut();\n```\n\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1295,"character":11}]},{"id":826,"name":"useUserAccessGroup","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":827,"name":"useUserAccessGroup","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Switch userAccessGroup and current user to the given accessGroup and the user stored in it.\nSign in a user with any sign in method, and the same current user is available in all\napps in the access group.","text":"Set the `useAccessGroup` argument to `null` to stop sharing the auth state (default behaviour), the user state will no longer be\navailable to any other apps.\n","tags":[{"tag":"platform","text":"ios\n"}]},"parameters":[{"id":828,"name":"userAccessGroup","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A string of the keychain id i.e. \"TEAMID.com.example.group1\"\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1609,"character":22}]},{"id":823,"name":"verifyPasswordResetCode","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":824,"name":"verifyPasswordResetCode","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Checks a password reset code sent to the user by email or other out-of-band mechanism.\nTODO salakar: confirm return behavior (Returns the user's email address if valid.)","text":"#### Example\n\n```js\nawait firebase.auth().verifyPasswordResetCode('ABCD');\n```\n","tags":[{"tag":"error","text":"auth/expired-action-code Thrown if the password reset code has expired."},{"tag":"error","text":"auth/invalid-action-code Thrown if the password reset code is invalid. This can happen if the code is malformed or has already been used."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given password reset code has been disabled."},{"tag":"error","text":"auth/user-not-found Thrown if there is no user corresponding to the password reset code. This may have happened if the user was deleted between when the code was issued and when this method was called."}]},"parameters":[{"id":825,"name":"code","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A password reset code.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1596,"character":27}]},{"id":776,"name":"verifyPhoneNumber","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":777,"name":"verifyPhoneNumber","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a PhoneAuthListener to listen to phone verification events,\non the final completion event a PhoneAuthCredential can be generated for\nauthentication purposes.","text":"#### Example\n\n```js\nfirebase.auth().verifyPhoneNumber('+4423456789', )\n .on('state_changed', (phoneAuthSnapshot) => {\n   console.log('Snapshot state: ', phoneAuthSnapshot.state);\n });\n```\n"},"parameters":[{"id":778,"name":"phoneNumber","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The phone number identifier supplied by the user. Its format is normalized on the server, so it can be in any format here. (e.g. +16505550101)."},"type":{"type":"intrinsic","name":"string"}},{"id":779,"name":"autoVerifyTimeoutOrForceResend","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"If a number, sets in seconds how to to wait until auto verification times out. If boolean, sets the `forceResend` parameter."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"boolean"}]}},{"id":780,"name":"forceResend","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"If true, resend the verification message even if it was recently sent.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"type":{"type":"reference","name":"PhoneAuthListener","id":661}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1348,"character":21}]}],"groups":[{"title":"Properties","kind":1024,"children":[829,752,751]},{"title":"Accessors","kind":262144,"children":[747]},{"title":"Methods","kind":2048,"children":[814,817,810,781,820,803,753,758,763,795,799,770,792,789,785,806,772,768,826,823,776]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1167,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":640,"name":"ActionCodeInfo","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The interface returned from a {@link auth#checkActionCode} call.","text":"#### Example\n\n```js\nconst actionCodeInfo = await firebase.auth().checkActionCode('ABCD');\nconsole.log('Action code operation: ', actionCodeInfo.operation);\n```\n"},"children":[{"id":641,"name":"data","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The data associated with the action code."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":561,"character":8}],"type":{"type":"reference","name":"ActionCodeInfoData","id":637}},{"id":642,"name":"operation","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The operation from where the action originated."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":565,"character":13}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"PASSWORD_RESET"},{"type":"stringLiteral","value":"VERIFY_EMAIL"},{"type":"stringLiteral","value":"RECOVER_EMAIL"},{"type":"stringLiteral","value":"EMAIL_SIGNIN"},{"type":"stringLiteral","value":"ERROR"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[641,642]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":557,"character":33}]},{"id":637,"name":"ActionCodeInfoData","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Additional data returned from a {@link auth#checkActionCode} call.\nFor the PASSWORD_RESET, VERIFY_EMAIL, and RECOVER_EMAIL actions, this object contains an email field with the address the email was sent to.\nFor the RECOVER_EMAIL action, which allows a user to undo an email address change, this object also contains a fromEmail field with the user account's new email address. After the action completes, the user's email address will revert to the value in the email field from the value in fromEmail field.","text":"#### Example\n\n```js\nconst actionCodeInfo = await firebase.auth().checkActionCode('ABCD');\nData\nconsole.log('Action code email: ', actionCodeInfo.data.email);\nconsole.log('Action code from email: ', actionCodeInfo.data.fromEmail);\n```\n"},"children":[{"id":638,"name":"email","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"This signifies the email before the call was made."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":540,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":639,"name":"fromEmail","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"This signifies the current email associated with the account, which may have changed as a result of the {@link auth#checkActionCode} call performed."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":544,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[638,639]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":536,"character":37}]},{"id":645,"name":"ActionCodeSettings","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Options to be sent with requests such as {@link auth.User#sendEmailVerification}.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.sendEmailVerification({\n handleCodeInApp: true,\n url: 'app/email-verification',\n});\n```\n"},"children":[{"id":646,"name":"android","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Android specific settings."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":605,"character":11}],"type":{"type":"reference","name":"ActionCodeSettingsAndroid","id":633}},{"id":649,"name":"dynamicLinkDomain","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the dynamic link domain (or subdomain) to use for the current link if it is to be opened using Firebase Dynamic Links. As multiple dynamic link domains can be configured per project, this field provides the ability to explicitly choose one. If none is provided, the first domain is used by default."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":620,"character":21}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":647,"name":"handleCodeInApp","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Whether the email action link will be opened in a mobile app or a web link first. The default is false. When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":610,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":648,"name":"iOS","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"iOS specific settings."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":615,"character":7}],"type":{"type":"reference","name":"ActionCodeSettingsIos","id":643}},{"id":650,"name":"url","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"This URL represents the state/Continue URL in the form of a universal link. This URL can should be constructed as a universal link that would either directly open the app where the action code would be handled or continue to the app after the action code is handled by Firebase."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":625,"character":7}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[646,649,647,648,650]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":601,"character":37}]},{"id":633,"name":"ActionCodeSettingsAndroid","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Android specific options which can be attached to the {@link auth.ActionCodeSettings} object\nto be sent with requests such as {@link auth.User#sendEmailVerification}.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.sendEmailVerification({\n android: {\n   installApp: true,\n   packageName: 'com.awesome.app',\n },\n});\n```\n"},"children":[{"id":635,"name":"installApp","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If installApp is passed, it specifies whether to install the Android app if the device supports it and the app is not already installed. If this field is provided without a packageName, an error is thrown explaining that the packageName must be provided in conjunction with this field."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":515,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":636,"name":"minimumVersion","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If minimumVersion is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app. The Android app needs to be registered in the Console."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":519,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":634,"name":"packageName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Sets the Android package name. This will try to open the link in an android app if it is installed."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":511,"character":15}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[635,636,634]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":507,"character":44}]},{"id":643,"name":"ActionCodeSettingsIos","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"iOS specific options which can be attached to the {@link auth.ActionCodeSettings} object\nto be sent with requests such as {@link auth.User#sendEmailVerification}.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.sendEmailVerification({\n iOS: {\n   bundleId: '123456',\n },\n});\n```\n"},"children":[{"id":644,"name":"bundleId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed. The iOS app needs to be registered in the Console."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":586,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[644]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":582,"character":40}]},{"id":597,"name":"AdditionalUserInfo","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A structure containing additional user information from a federated identity provider via {@link auth.UserCredential}.","text":"#### Example\n\n```js\nconst userCredential = await firebase.auth().signInAnonymously();\nconsole.log('Additional user info: ', userCredential.additionalUserInfo);\n```\n","tags":[{"tag":"error","text":"auth/operation-not-allowed Thrown if anonymous accounts are not enabled. Enable anonymous accounts in the Firebase Console, under the Auth tab.\n"}]},"children":[{"id":598,"name":"isNewUser","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns whether the user is new or existing."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":296,"character":13}],"type":{"type":"intrinsic","name":"boolean"}},{"id":599,"name":"profile","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns an Object containing IDP-specific user data if the provider is one of Facebook,\nGitHub, Google, Twitter, Microsoft, or Yahoo."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":301,"character":11}],"type":{"type":"reference","name":"Object"}},{"id":600,"name":"providerId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the provider ID for specifying which provider the information in `profile` is for."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":305,"character":14}],"type":{"type":"intrinsic","name":"string"}},{"id":601,"name":"username","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns the username if the provider is GitHub or Twitter."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":309,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[598,599,600,601]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":292,"character":37}]},{"id":557,"name":"AuthCredential","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Interface that represents the credentials returned by an auth provider. Implementations specify the details\nabout each auth provider's credential requirements.","text":"TODO Missing; signInMethod, toJSON, fromJSON\n\n#### Example\n\n```js\nconst provider = firebase.auth.EmailAuthProvider;\nconst authCredential = provider.credential('foo@bar.com', '123456');\n\nawait firebase.auth().signInWithCredential(authCredential);\n```\n"},"children":[{"id":558,"name":"providerId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The authentication provider ID for the credential. For example, 'facebook.com', or 'google.com'."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":74,"character":14}],"type":{"type":"intrinsic","name":"string"}},{"id":560,"name":"secret","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":76,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":559,"name":"token","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":75,"character":9}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[558,560,559]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":70,"character":33}]},{"id":561,"name":"AuthProvider","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Interface that represents an auth provider. Implemented by other providers."},"children":[{"id":562,"name":"PROVIDER_ID","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The provider ID of the provider."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":86,"character":15}],"type":{"type":"intrinsic","name":"string"}},{"id":563,"name":"credential","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Creates a new `AuthCredential`.","tags":[{"tag":"returns","text":"."},{"tag":"param","text":"A provider token.","param":"token"},{"tag":"param","text":"A provider secret.\n","param":"secret"}]},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":94,"character":14}],"type":{"type":"reflection","declaration":{"id":564,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":565,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":566,"name":"token","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":567,"name":"secret","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"AuthCredential","id":557}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":94,"character":15}]}}}],"groups":[{"title":"Properties","kind":1024,"children":[562,563]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":82,"character":31}]},{"id":693,"name":"AuthSettings","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Interface for module auth settings.","text":"#### Example\n\n```js\nconst settings = firebase.auth().settings;\nconsole.log(settings.appVerificationDisabledForTesting);\n```\n"},"children":[{"id":694,"name":"appVerificationDisabledForTesting","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"iOS only flag to disable app verification for the purpose of testing phone authentication. For this property to take effect, it needs to be set before rendering a reCAPTCHA app verifier. When this is disabled, a mock reCAPTCHA is rendered instead. This is useful for manual testing during development or for automated integration tests.","text":"> In order to use this feature, you will need to [whitelist your phone number](https://firebase.google.com/docs/auth/web/phone-auth#test-with-whitelisted-phone-numbers) via the Firebase Console.\n","tags":[{"tag":"ios","text":""},{"tag":"param","text":"Boolean value representing whether app verification should be disabled for testing.\n","param":"disabled"}]},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":822,"character":37}],"type":{"type":"intrinsic","name":"boolean"}},{"id":695,"name":"setAutoRetrievedSmsCodeForPhoneNumber","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":696,"name":"setAutoRetrievedSmsCodeForPhoneNumber","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Calling this method a second time will overwrite the previously passed parameters.\nOnly one number can be configured at a given time.","text":"> The phone number and SMS code here must have been configured in the Firebase Console (Authentication > Sign In Method > Phone).\n\n#### Example\n\n```js\nawait firebase.auth().settings.setAutoRetrievedSmsCodeForPhoneNumber('+4423456789', 'ABCDE');\n```\n","tags":[{"tag":"android","text":""}]},"parameters":[{"id":697,"name":"phoneNumber","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users phone number."},"type":{"type":"intrinsic","name":"string"}},{"id":698,"name":"smsCode","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The pre-set SMS code.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":840,"character":41}]}],"groups":[{"title":"Properties","kind":1024,"children":[694]},{"title":"Methods","kind":2048,"children":[695]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":813,"character":31}]},{"id":628,"name":"ConfirmationResult","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A result from a {@link auth#signInWithPhoneNumber} call.","text":"#### Example\n\n```js\n// Force a new message to be sent\nconst result = await firebase.auth().signInWithPhoneNumber('#4423456789');\nconst user = await result.confirm('12345');\n```\n"},"children":[{"id":629,"name":"verificationId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The phone number authentication operation's verification ID. This can be used along with\nthe verification code to initialize a phone auth credential."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":483,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":630,"name":"confirm","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":631,"name":"confirm","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Finishes the sign in flow. Validates a code that was sent to the users device."},"parameters":[{"id":632,"name":"verificationCode","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The code sent to the users device from Firebase.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"union","types":[{"type":"reference","name":"User","id":699},{"type":"intrinsic","name":"null"}]}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":489,"character":11}]}],"groups":[{"title":"Properties","kind":1024,"children":[629]},{"title":"Methods","kind":2048,"children":[630]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":478,"character":37}]},{"id":568,"name":"EmailAuthProvider","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Email and password auth provider implementation."},"children":[{"id":570,"name":"EMAIL_LINK_SIGN_IN_METHOD","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"This corresponds to the sign-in method identifier as returned in {@link auth#fetchSignInMethodsForEmail}.","text":"#### Example\n\n```js\nconst signInMethods = await firebase.auth().fetchSignInMethodsForEmail('...');\nif (signInMethods.indexOf(firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD) != -1) {\n  // User can sign in with email/link\n}\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":117,"character":29}],"type":{"type":"intrinsic","name":"string"}},{"id":571,"name":"EMAIL_PASSWORD_SIGN_IN_METHOD","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"This corresponds to the sign-in method identifier as returned in {@link auth#fetchSignInMethodsForEmail}.","text":"#### Example\n\n```js\nconst signInMethods = await firebase.auth().fetchSignInMethodsForEmail('...');\nif (signInMethods.indexOf(firebase.auth.EmailAuthProvider.EMAIL_PASSWORD_SIGN_IN_METHOD) != -1) {\n  // User can sign in with email/password\n}\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":130,"character":33}],"type":{"type":"intrinsic","name":"string"}},{"id":569,"name":"PROVIDER_ID","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The provider ID. Always returns `password`."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":104,"character":15}],"type":{"type":"intrinsic","name":"string"}},{"id":572,"name":"credential","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the auth provider credential.","text":"#### Example\n\n```js\nconst authCredential = firebase.auth.EmailAuthProvider.credential('joe.bloggs@example.com', '123456');\n```\n","tags":[{"tag":"returns","text":""},{"tag":"param","text":"Users email address.","param":"email"},{"tag":"param","text":"User account password.\n","param":"password"}]},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":144,"character":14}],"type":{"type":"reflection","declaration":{"id":573,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":574,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":575,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":576,"name":"password","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"AuthCredential","id":557}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":144,"character":15}]}}},{"id":577,"name":"credentialWithLink","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Initialize an `EmailAuthProvider` credential using an email and an email link after a sign in with email link operation.","text":"#### Example\n\n```js\nconst authCredential = firebase.auth.EmailAuthProvider.credentialWithLink('joe.bloggs@example.com', 'https://myexample.com/invite');\n```\n","tags":[{"tag":"param","text":"Users email address.","param":"email"},{"tag":"param","text":"Sign-in email link.\n","param":"emailLink"}]},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":157,"character":22}],"type":{"type":"reflection","declaration":{"id":578,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":579,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":580,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":581,"name":"emailLink","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"AuthCredential","id":557}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":157,"character":23}]}}}],"groups":[{"title":"Properties","kind":1024,"children":[570,571,569,572,577]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":100,"character":36}]},{"id":615,"name":"IdTokenResult","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Interface representing ID token result obtained from {@link auth.User#getIdTokenResult}.\nIt contains the ID token JWT string and other helper properties for getting different data\nassociated with the token as well as all the decoded payload claims.","text":"TODO @salakar validate timestamp types\n\n#### Example\n\n```js\nconst idTokenResult = await firebase.auth().currentUser.getIdTokenResult();\nconsole.log('User JWT: ', idTokenResult.token);\n```\n"},"children":[{"id":617,"name":"authTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The authentication time formatted as a UTC string. This is the time the user authenticated\n(signed in) and not the time the token was refreshed."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":419,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":621,"name":"claims","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The entire payload claims of the ID token including the standard reserved claims as well as\nthe custom claims."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":437,"character":10}],"type":{"type":"reflection","declaration":{"id":622,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":623,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":624,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":437,"character":11}]}}},{"id":619,"name":"expirationTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The ID token expiration time formatted as a UTC string."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":427,"character":18}],"type":{"type":"intrinsic","name":"string"}},{"id":618,"name":"issuedAtTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The ID token issued at time formatted as a UTC string."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":423,"character":16}],"type":{"type":"intrinsic","name":"string"}},{"id":620,"name":"signInProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The sign-in provider through which the ID token was obtained (anonymous, custom,\nphone, password, etc). Note, this does not map to provider IDs."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":432,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"string"}]}},{"id":616,"name":"token","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Firebase Auth ID token JWT string."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":414,"character":9}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[617,621,619,618,620,616]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":410,"character":32}]},{"id":656,"name":"PhoneAuthError","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A custom error in the event verifying a phone number failed.","text":"#### Example\n\n```js\nfirebase.auth().verifyPhoneNumber('+4423456789')\n .on('state_changed', (phoneAuthSnapshot) => {\n   console.log('Snapshot state: ', phoneAuthSnapshot.state);\n }, (phoneAuthError) => {\n   console.error('Error: ', phoneAuthError.message);\n });\n```\n"},"children":[{"id":657,"name":"code","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The code the verification failed with."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":701,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":659,"name":"message","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"JavaScript error message."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":709,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":660,"name":"stack","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"JavaScript error stack trace."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":713,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":658,"name":"verificationId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The verification ID which failed."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":705,"character":18}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[657,659,660,658]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":697,"character":33}]},{"id":661,"name":"PhoneAuthListener","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The listener function returned from a {@link auth#verifyPhoneNumber} call."},"children":[{"id":687,"name":"catch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":688,"name":"catch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"A promise handler called once the `on` listener flow has rejected.","text":"#### Example\n\n```js\nfirebase.auth().verifyPhoneNumber('+4423456789')\n .on('state_changed', (phoneAuthSnapshot) => {\n   return Promise.reject(\n     new Error('Code not sent!')\n   );\n })\n .catch((error) => {\n   console.error(error.message);\n });\n```\n\n> Used when no `onRejected` handler is passed to {@link auth.PhoneAuthListener#then}.\n"},"parameters":[{"id":689,"name":"onRejected","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Rejected promise handler.\n"},"type":{"type":"reflection","declaration":{"id":690,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":691,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":692,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"NativeFirebaseError","id":2}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":800,"character":21}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"any"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":800,"character":9}]},{"id":662,"name":"on","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":663,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"The phone auth state listener. See {@link auth.PhoneAuthState} for different event state types.","text":"#### Example\n\n```js\nfirebase.auth().verifyPhoneNumber('+4423456789')\n .on('state_changed', (phoneAuthSnapshot) => {\n   console.log('State: ', phoneAuthSnapshot.state);\n }, (error) => {\n   console.error(error);\n }, (phoneAuthSnapshot) => {\n   console.log('Success');\n });\n```\n"},"parameters":[{"id":664,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The event to subscribe to. Currently only `state_changed` is available."},"type":{"type":"intrinsic","name":"string"}},{"id":665,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The required observer function. Returns a new phone auth snapshot on each event."},"type":{"type":"reflection","declaration":{"id":666,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":667,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":668,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"PhoneAuthSnapshot","id":651}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":743,"character":15}]}}},{"id":669,"name":"errorCb","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional error handler function. This is not required if the `error` snapshot state is being handled in the `observer`."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":670,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":671,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":672,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"PhoneAuthError","id":656}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":673,"name":"successCb","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional success handler function. This is not required if the `sent` or `verified` snapshot state is being handled in the `observer`.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":674,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":675,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":676,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"PhoneAuthSnapshot","id":651}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reference","name":"PhoneAuthListener","id":661}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":741,"character":6}]},{"id":677,"name":"then","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":678,"name":"then","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"A promise handler called once the `on` listener flow has succeeded or rejected.","text":"#### Example\n\n```js\nfirebase.auth().verifyPhoneNumber('+4423456789')\n .on('state_changed', (phoneAuthSnapshot) => {\n   if (phoneAuthSnapshot.state === firebase.auth.PhoneAuthState.CODE_SENT) {\n     return Promise.resolve();\n   } else {\n     return Promise.reject(\n       new Error('Code not sent!')\n     );\n   }\n })\n .then((phoneAuthSnapshot) => {\n   console.log(phoneAuthSnapshot.state);\n }, (error) => {\n   console.error(error.message);\n });\n```\n"},"parameters":[{"id":679,"name":"onFulfilled","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Resolved promise handler."},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":680,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":681,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":682,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"PhoneAuthSnapshot","id":651}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":775,"character":19}]}},{"type":"intrinsic","name":"null"}]}},{"id":683,"name":"onRejected","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Rejected promise handler.\n"},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":684,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":685,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":686,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"NativeFirebaseError","id":2}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":776,"character":18}]}},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"any"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":774,"character":8}]}],"groups":[{"title":"Methods","kind":2048,"children":[687,662,677]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":719,"character":36}]},{"id":651,"name":"PhoneAuthSnapshot","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A snapshot interface of the current phone auth state.","text":"#### Example\n\n```js\nfirebase.auth().verifyPhoneNumber('+4423456789')\n .on('state_changed', (phoneAuthSnapshot) => {\n   console.log('Snapshot state: ', phoneAuthSnapshot.state);\n });\n```\n"},"children":[{"id":654,"name":"code","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The verification code. Will only be available if auto verification has taken place."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":676,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":655,"name":"error","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A native JavaScript error if an error occurs."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":680,"character":9}],"type":{"type":"union","types":[{"type":"reference","name":"NativeFirebaseError","id":2},{"type":"intrinsic","name":"null"}]}},{"id":652,"name":"state","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current phone auth verification state.","text":"- `sent`: On iOS, this is the final event received. Once sent, show a visible input box asking the user to enter the verification code.\n- `timeout`: Auto verification has timed out. Show a visible input box asking the user to enter the verification code.\n- `verified`: The verification code has automatically been verified by the Android device. The snapshot contains the verification ID & code to create a credential.\n- `error`: An error occurred. Handle or allow the promise to reject.\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":668,"character":9}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"sent"},{"type":"stringLiteral","value":"timeout"},{"type":"stringLiteral","value":"verified"},{"type":"stringLiteral","value":"error"}]}},{"id":653,"name":"verificationId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The verification ID to build a `PhoneAuthProvider` credential."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":672,"character":18}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[654,655,652,653]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":659,"character":36}]},{"id":582,"name":"PhoneAuthState","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{},"children":[{"id":585,"name":"AUTO_VERIFIED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Phone number auto-verification succeeded."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":175,"character":17}],"type":{"type":"stringLiteral","value":"verified"}},{"id":584,"name":"AUTO_VERIFY_TIMEOUT","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"SMS message with verification code sent to phone number."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":171,"character":23}],"type":{"type":"stringLiteral","value":"timeout"}},{"id":583,"name":"CODE_SENT","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The timeout specified in {@link auth#verifyPhoneNumber} has expired."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":167,"character":13}],"type":{"type":"stringLiteral","value":"sent"}},{"id":586,"name":"ERROR","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Phone number verification failed with an error."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":179,"character":9}],"type":{"type":"stringLiteral","value":"error"}}],"groups":[{"title":"Properties","kind":1024,"children":[585,584,583,586]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":163,"character":33}]},{"id":587,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"firebase.auth.X"},"children":[{"id":591,"name":"AppleAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Apple auth provider implementation. Currently this is iOS only.","text":"For Apple Authentication please see our [`@invertase/react-native-apple-authentication`](https://github.com/invertase/react-native-apple-authentication) library which integrates well with Firebase and provides Firebase + Apple Auth examples.\n\n#### Example\n\n```js\nfirebase.auth.AppleAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":227,"character":21}],"type":{"type":"reference","name":"AuthProvider","id":561}},{"id":588,"name":"EmailAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Email and password auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.EmailAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":195,"character":21}],"type":{"type":"reference","name":"EmailAuthProvider","id":568}},{"id":594,"name":"FacebookAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Facebook auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.FacebookAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":257,"character":24}],"type":{"type":"reference","name":"AuthProvider","id":561}},{"id":592,"name":"GithubAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Github auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.GithubAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":237,"character":22}],"type":{"type":"reference","name":"AuthProvider","id":561}},{"id":590,"name":"GoogleAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Google auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.GoogleAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":215,"character":22}],"type":{"type":"reference","name":"AuthProvider","id":561}},{"id":595,"name":"OAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Custom OAuth auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.OAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":267,"character":17}],"type":{"type":"reference","name":"AuthProvider","id":561}},{"id":589,"name":"PhoneAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Phone auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.PhoneAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":205,"character":21}],"type":{"type":"reference","name":"AuthProvider","id":561}},{"id":596,"name":"PhoneAuthState","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A PhoneAuthState interface.","text":"#### Example\n\n```js\nfirebase.auth.PhoneAuthState;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":277,"character":18}],"type":{"type":"reference","name":"PhoneAuthState","id":582}},{"id":593,"name":"TwitterAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Twitter auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.TwitterAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":247,"character":23}],"type":{"type":"reference","name":"AuthProvider","id":561}}],"groups":[{"title":"Properties","kind":1024,"children":[591,588,594,592,590,595,589,596,593]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":185,"character":26}]},{"id":625,"name":"UpdateProfile","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Request used to update user profile information.","text":"#### Example\n\n```js\nconst update = {\n  displayName: 'Alias',\n  photoURL: 'https://my-cdn.com/assets/user/123.png',\n};\n\nawait firebase.auth().currentUser.updateProfile(update);\n```\n"},"children":[{"id":626,"name":"displayName","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An optional display name for the user."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":460,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":627,"name":"photoURL","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An optional photo URL for the user."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":464,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[626,627]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":456,"character":32}]},{"id":699,"name":"User","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a user's profile information in your Firebase project's user database. It also\ncontains helper methods to change or retrieve profile information, as well as to manage that user's authentication state.","text":"#### Example 1\n\nSubscribing to the users authentication state.\n\n```js\nfirebase.auth().onAuthStateChanged((user) => {\n  if (user) {\n    console.log('User email: ', user.email');\n  }\n});\n```\n\n#### Example 2\n\n```js\nconst user = firebase.auth().currentUser;\n\nif (user) {\n console.log('User email: ', user.email');\n}\n```\n"},"children":[{"id":700,"name":"displayName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The user's display name (if available)."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":873,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":701,"name":"email","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"- The user's email address (if available)."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":877,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":702,"name":"emailVerified","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"- True if the user's email address has been verified."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":881,"character":17}],"type":{"type":"intrinsic","name":"boolean"}},{"id":703,"name":"isAnonymous","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns true if the user is anonymous; that is, the user account was created with\n{@link auth#signInAnonymously} and has not been linked to another account\nwith {@link auth#linkWithCredential}."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":887,"character":15}],"type":{"type":"intrinsic","name":"boolean"}},{"id":704,"name":"metadata","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the {@link auth.UserMetadata} associated with this user."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":892,"character":12}],"type":{"type":"reference","name":"UserMetadata","id":605}},{"id":705,"name":"phoneNumber","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the phone number of the user, as stored in the Firebase project's user database,\nor null if none exists. This can be updated at any time by calling {@link auth.User#updatePhoneNumber}."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":898,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":706,"name":"photoURL","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The URL of the user's profile picture (if available)."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":903,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":707,"name":"providerData","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Additional provider-specific information about the user."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":908,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"UserInfo","id":608}}},{"id":708,"name":"providerId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":" The authentication provider ID for the current user.\n For example, 'facebook.com', or 'google.com'."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":914,"character":14}],"type":{"type":"intrinsic","name":"string"}},{"id":709,"name":"uid","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":" - The user's unique ID."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":919,"character":7}],"type":{"type":"intrinsic","name":"string"}},{"id":710,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":711,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Delete the current user.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.delete();\n```\n","tags":[{"tag":"error","text":"auth/requires-recent-login Thrown if the user's last sign-in time does not meet the security threshold. Use `auth.User#reauthenticateWithCredential` to resolve. This does not apply if the user is anonymous.\n"}]},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":932,"character":10}]},{"id":712,"name":"getIdToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":713,"name":"getIdToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the users authentication token.","text":"#### Example\n\n```js\n// Force a token refresh\nconst idToken = await firebase.auth().currentUser.getIdToken(true);\n```\n"},"parameters":[{"id":714,"name":"forceRefresh","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A boolean value which forces Firebase to refresh the token.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":946,"character":14}]},{"id":715,"name":"getIdTokenResult","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":716,"name":"getIdTokenResult","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a firebase.auth.IdTokenResult object which contains the ID token JWT string and\nother helper properties for getting different data associated with the token as well as\nall the decoded payload claims.","text":"#### Example\n\n```js\n// Force a token refresh\nconst idTokenResult = await firebase.auth().currentUser.getIdTokenResult(true);\n```\n"},"parameters":[{"id":717,"name":"forceRefresh","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"boolean Force refresh regardless of token expiration.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"IdTokenResult","id":615}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":962,"character":20}]},{"id":718,"name":"linkWithCredential","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":719,"name":"linkWithCredential","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Link the user with a 3rd party credential provider.","text":"#### Example\n\n```js\nconst facebookCredential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook');\nconst userCredential = await firebase.auth().currentUser.linkWithCredential(facebookCredential);\n```\n","tags":[{"tag":"error","text":"auth/provider-already-linked Thrown if the provider has already been linked to the user. This error is thrown even if this is not the same provider's account that is currently linked to the user."},{"tag":"error","text":"auth/invalid-credential Thrown if the provider's credential is not valid. This can happen if it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method."},{"tag":"error","text":"auth/credential-already-in-use Thrown if the account corresponding to the credential already exists among your users, or is already linked to a Firebase User."},{"tag":"error","text":"auth/email-already-in-use Thrown if the email corresponding to the credential already exists among your users."},{"tag":"error","text":"auth/operation-not-allowed Thrown if you have not enabled the provider in the Firebase Console. Go to the Firebase Console for your project, in the Auth section and the Sign in Method tab and configure the provider."},{"tag":"error","text":"auth/invalid-email Thrown if the email used in a auth.EmailAuthProvider.credential is invalid."},{"tag":"error","text":"auth/wrong-password Thrown if the password used in a auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password."},{"tag":"error","text":"auth/invalid-verification-code Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification code of the credential is not valid."},{"tag":"error","text":"auth/invalid-verification-id Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid."}]},"parameters":[{"id":720,"name":"credential","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A created {@link auth.AuthCredential}.\n"},"type":{"type":"reference","name":"AuthCredential","id":557}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":985,"character":22}]},{"id":721,"name":"reauthenticateWithCredential","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":722,"name":"reauthenticateWithCredential","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Re-authenticate a user with a third-party authentication provider.","text":"#### Example\n\n```js\nconst facebookCredential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook');\nconst userCredential = await firebase.auth().currentUser.reauthenticateWithCredential(facebookCredential);\n```\n","tags":[{"tag":"error","text":"auth/user-mismatch Thrown if the credential given does not correspond to the user."},{"tag":"error","text":"auth/user-not-found Thrown if the credential given does not correspond to any existing user."},{"tag":"error","text":"auth/invalid-credential Thrown if the provider's credential is not valid. This can happen if it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method."},{"tag":"error","text":"auth/invalid-email Thrown if the email used in a auth.EmailAuthProvider.credential is invalid."},{"tag":"error","text":"auth/wrong-password Thrown if the password used in a auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password."},{"tag":"error","text":"auth/invalid-verification-code Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification code of the credential is not valid."},{"tag":"error","text":"auth/invalid-verification-id Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid."}]},"parameters":[{"id":723,"name":"credential","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A created {@link auth.AuthCredential}.\n"},"type":{"type":"reference","name":"AuthCredential","id":557}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1006,"character":32}]},{"id":724,"name":"reload","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":725,"name":"reload","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Refreshes the current user.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.reload();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1017,"character":10}]},{"id":726,"name":"sendEmailVerification","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":727,"name":"sendEmailVerification","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends a verification email to a user.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.sendEmailVerification({\n  handleCodeInApp: true,\n});\n```\n\n> This will Promise reject if the user is anonymous.\n","tags":[{"tag":"error","text":"auth/missing-android-pkg-name An Android package name must be provided if the Android app is required to be installed."},{"tag":"error","text":"auth/missing-continue-uri A continue URL must be provided in the request."},{"tag":"error","text":"auth/missing-ios-bundle-id An iOS bundle ID must be provided if an App Store ID is provided."},{"tag":"error","text":"auth/invalid-continue-uri The continue URL provided in the request is invalid."},{"tag":"error","text":"auth/unauthorized-continue-uri The domain of the continue URL is not whitelisted. Whitelist the domain in the Firebase console."}]},"parameters":[{"id":728,"name":"actionCodeSettings","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Any optional additional settings to be set before sending the verification email.\n"},"type":{"type":"reference","name":"ActionCodeSettings","id":645}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1039,"character":25}]},{"id":729,"name":"toJSON","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":730,"name":"toJSON","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a JSON-serializable representation of this object.","text":"#### Example\n\n```js\nconst user = firebase.auth().currentUser.toJSON();\n```\n"},"type":{"type":"intrinsic","name":"object"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1050,"character":10}]},{"id":731,"name":"unlink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":732,"name":"unlink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unlinks a provider from a user account.","text":"#### Example\n\n```js\nconst user = await firebase.auth().currentUser.unlink('facebook.com');\n```\n","tags":[{"tag":"error","text":"auth/no-such-provider Thrown if the user does not have this provider linked or when the provider ID given does not exist."}]},"parameters":[{"id":733,"name":"providerId","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"User","id":699}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1064,"character":10}]},{"id":734,"name":"updateEmail","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":735,"name":"updateEmail","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates the user's email address.","text":"See Firebase docs for more information on security & email validation.\n\n#### Example\n\n```js\nawait firebase.auth().currentUser.updateEmail('joe.bloggs@new-email.com');\n```\n\n> This will Promise reject if the user is anonymous.\n","tags":[{"tag":"error","text":"auth/invalid-email Thrown if the email used is invalid."},{"tag":"error","text":"auth/email-already-in-use Thrown if the email is already used by another user."},{"tag":"error","text":"auth/requires-recent-login Thrown if the user's last sign-in time does not meet the security threshold."}]},"parameters":[{"id":736,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users new email address.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1084,"character":15}]},{"id":737,"name":"updatePassword","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":738,"name":"updatePassword","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates the users password.","text":"Important: this is a security sensitive operation that requires the user to have recently signed in.\nIf this requirement isn't met, ask the user to authenticate again and then call firebase.User#reauthenticate.\n\n#### Example\n\n```js\nawait firebase.auth().currentUser.updatePassword('654321');\n```\n\n> This will Promise reject is the user is anonymous.\n","tags":[{"tag":"error","text":"auth/weak-password Thrown if the password is not strong enough."},{"tag":"error","text":"auth/requires-recent-login Thrown if the user's last sign-in time does not meet the security threshold."}]},"parameters":[{"id":739,"name":"password","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users new password.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1104,"character":18}]},{"id":740,"name":"updatePhoneNumber","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":741,"name":"updatePhoneNumber","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates the user's phone number.","text":"See Firebase docs for more information on security & email validation.\n\n#### Example\n\n```js\nconst snapshot = await firebase.auth().verifyPhoneNumber('+4423456789')\n .on(...); // See PhoneAuthListener - wait for successful verification\n\nconst credential = firebase.auth.PhoneAuthProvider.credential(snapshot.verificationId, snapshot.code);\n\n// Update user with new verified phone number\nawait firebase.auth().currentUser.updatePhoneNumber(credential);\n```\n\n> This will Promise reject is the user is anonymous.\n","tags":[{"tag":"error","text":"auth/invalid-verification-code Thrown if the verification code of the credential is not valid."},{"tag":"error","text":"auth/invalid-verification-id Thrown if the verification ID of the credential is not valid."}]},"parameters":[{"id":742,"name":"credential","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A created `PhoneAuthCredential`.\n"},"type":{"type":"reference","name":"AuthCredential","id":557}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1129,"character":21}]},{"id":743,"name":"updateProfile","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":744,"name":"updateProfile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates a user's profile data.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.updateProfile({\n  displayName: 'Alias',\n});\n```\n"},"parameters":[{"id":745,"name":"updates","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"UpdateProfile","id":625}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1142,"character":17}]}],"groups":[{"title":"Properties","kind":1024,"children":[700,701,702,703,704,705,706,707,708,709]},{"title":"Methods","kind":2048,"children":[710,712,715,718,721,724,726,729,731,734,737,740,743]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":869,"character":23}]},{"id":602,"name":"UserCredential","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A structure containing a User, an AuthCredential, the operationType, and any additional user\ninformation that was returned from the identity provider. operationType could be 'signIn' for\na sign-in operation, 'link' for a linking operation and 'reauthenticate' for a reauthentication operation.","text":"TODO @salakar; missing credential, operationType\n"},"children":[{"id":603,"name":"additionalUserInfo","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Any additional user information assigned to the user."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":323,"character":22}],"type":{"type":"reference","name":"AdditionalUserInfo","id":597}},{"id":604,"name":"user","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the {@link auth.User} interface of this credential."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":327,"character":8}],"type":{"type":"reference","name":"User","id":699}}],"groups":[{"title":"Properties","kind":1024,"children":[603,604]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":319,"character":33}]},{"id":608,"name":"UserInfo","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a collection of standard profile information for a user. Can be used to expose\nprofile information returned by an identity provider, such as Google Sign-In or Facebook Login.","text":"TODO @salakar: isEmailVerified\n\n#### Example\n\n```js\nconst user = firebase.auth().currentUser;\n\nuser.providerData.forEach((userInfo) => {\n  console.log('User info for provider: ', userInfo);\n});\n```\n"},"children":[{"id":609,"name":"displayName","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns the user's display name, if available."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":373,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":610,"name":"email","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns the email address corresponding to the user's account in the specified provider, if available."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":377,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":611,"name":"phoneNumber","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The phone number normalized based on the E.164 standard (e.g. +16505550101) for the current user. This is null if the user has no phone credential linked to the account."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":381,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":612,"name":"photoURL","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns a url to the user's profile picture, if available."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":385,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":613,"name":"providerId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the unique identifier of the provider type that this instance corresponds to."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":389,"character":14}],"type":{"type":"intrinsic","name":"string"}},{"id":614,"name":"uid","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a user identifier as specified by the authentication provider."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":393,"character":7}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[609,610,611,612,613,614]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":369,"character":27}]},{"id":605,"name":"UserMetadata","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Holds the user metadata for the current {@link auth.User}.","text":"#### Example\n\n```js\nconst user = firebase.auth().currentUser;\nconsole.log('User metadata: ', user.metadata);\n```\n"},"children":[{"id":606,"name":"creationTime","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns the timestamp at which this account was created as dictated by the server clock\nas an ISO Date string."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":345,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":607,"name":"lastSignInTime","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns the last signin timestamp as dictated by the server clock as an ISO Date string.\nThis is only accurate up to a granularity of 2 minutes for consecutive sign-in attempts."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":350,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[606,607]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":340,"character":31}]},{"id":830,"name":"AuthListenerCallback","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"An auth listener callback function for {@link auth#onAuthStateChanged}.","text":"#### Example\n\n```js\nfunction listener(user) {\n  if (user) {\n    // Signed in\n  } else {\n    // Signed out\n  }\n}\n\nfirebase.auth().onAuthStateChanged(listener);\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":645,"character":34}],"type":{"type":"reflection","declaration":{"id":831,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":832,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":833,"name":"user","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"reference","name":"User","id":699},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":645,"character":36}]}}}],"groups":[{"title":"Classes","kind":128,"children":[746]},{"title":"Interfaces","kind":256,"children":[640,637,645,633,643,597,557,561,693,628,568,615,656,661,651,582,587,625,699,602,608,605]},{"title":"Type aliases","kind":4194304,"children":[830]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":51,"character":34}]},{"id":841,"name":"FirebaseCrashlyticsTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Crashlytics package for React Native.","text":"#### Example: Access the firebase export from the `crashlytics` package:\n\n```js\nimport { firebase } from '@react-native-firebase/crashlytics';\n\n// firebase.crashlytics().X\n```\n\n#### Example: Using the default export from the `crashlytics` package:\n\n```js\nimport crashlytics from '@react-native-firebase/crashlytics';\n\n// crashlytics().X\n```\n\n#### Example: Using the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/crashlytics';\n\n// firebase.crashlytics().X\n```\n","tags":[{"tag":"firebase","text":"crashlytics\n"}]},"children":[{"id":843,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Crashlytics service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Crashlytics service for the default app:\n\n```js\nconst defaultAppCrashlytics = firebase.crashlytics();\n```\n"},"children":[{"id":875,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":844,"name":"isCrashlyticsCollectionEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Whether Crashlytics reporting is enabled.","text":"#### Example\n\n```js\nconst isEnabled = firebase.crashlytics().isCrashlyticsCollectionEnabled;\n```\n\n"},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":79,"character":34}],"type":{"type":"intrinsic","name":"true"}},{"id":845,"name":"crash","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":846,"name":"crash","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Cause your app to crash for testing purposes. This is a native crash and will not contain a javascript stack trace.","text":"#### Example\n\n```js\nfirebase.crashlytics().crash();\n```\n\n"},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":91,"character":9}]},{"id":847,"name":"log","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":848,"name":"log","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Log a message that will appear in any subsequent Crash or Non-fatal error reports.","text":"#### Example\n\n```js\nfirebase.crashlytics().log('Testing a crash');\nfirebase.crashlytics().crash();\n```\n"},"parameters":[{"id":849,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":105,"character":7}]},{"id":850,"name":"recordError","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":851,"name":"recordError","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Record a JavaScript Error.","text":"The JavaScript stack trace is converted into a mock native iOS or Android exception before submission.\nThe line numbers in the stack trace (if available) will be relative to the javascript bundle built by your packager,\nafter whatever transpilation or minimization steps happen. You will need to maintain sourcemaps to decode them if desired.\n\n#### Example\n\n```js\nfirebase.crashlytics().recordError(\n new Error('An error was caught')\n);\n```\n"},"parameters":[{"id":852,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Expects an instance of Error; e.g. classes that extend Error will also be supported.\n"},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":124,"character":15}]},{"id":862,"name":"setAttribute","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":863,"name":"setAttribute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a string value to be associated with the given attribute name which will be visible in the Firebase Crashlytics console.","text":"#### Example\n\n```js\nawait firebase.crashlytics().setAttribute('role', 'admin');\n```\n"},"parameters":[{"id":864,"name":"name","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The name of the attribute to set."},"type":{"type":"intrinsic","name":"string"}},{"id":865,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A string value for the given attribute.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":189,"character":16}]},{"id":866,"name":"setAttributes","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":867,"name":"setAttributes","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Like `setAttribute` but for multiple attributes.","text":"#### Example\n\n```js\nawait firebase.crashlytics().setAttributes({\n  role: 'admin',\n  followers: '13',\n});\n```\n"},"parameters":[{"id":868,"name":"attributes","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object of key/value attribute name and values.\n"},"type":{"type":"reflection","declaration":{"id":869,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":870,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":871,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":205,"character":29}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":205,"character":17}]},{"id":872,"name":"setCrashlyticsCollectionEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":873,"name":"setCrashlyticsCollectionEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Enable/disable Crashlytics reporting.","text":"Use this for opt-in first user data collection flows combined with `firebase.json` settings to disable auto collection.\n\n#### Example\n\n```js\n// Disable crash reporting\nawait firebase.crashlytics().setCrashlyticsCollectionEnabled(false);\n```\n"},"parameters":[{"id":874,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A boolean value representing whether to enable Crashlytics error collection.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":221,"character":35}]},{"id":859,"name":"setUserEmail","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":860,"name":"setUserEmail","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Optionally specify a user email which will be visible in the Firebase Crashlytics console.","text":"If you choose to collect contact information it is strongly recommend that you disclose this in your apps privacy policy.\n\n#### Example\n\n```js\nfirebase.crashlytics().setUserEmail('user@gmail.com');\n```\n"},"parameters":[{"id":861,"name":"userEmail","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A users email address.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":175,"character":16}]},{"id":853,"name":"setUserId","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":854,"name":"setUserId","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Specify a user identifier which will be visible in the Firebase Crashlytics console.","text":"It is recommended for privacy purposes that this value be a value that's meaningless to a third-party\nobserver; such as an arbitrary string that ties an end-user to a record in your system e.g. a database record id.\n\n#### Example\n\n```js\n// Custom user id\nawait firebase.crashlytics().setUserId('123456789');\n// Firebase auth uid\nawait firebase.crashlytics().setUserId(\n firebase.auth().currentUser.uid\n);\n```\n"},"parameters":[{"id":855,"name":"userId","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An arbitrary string that ties an end-user to a record in your system e.g. a database record id.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":145,"character":13}]},{"id":856,"name":"setUserName","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":857,"name":"setUserName","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Optionally specify a user name which will be visible in the Firebase Crashlytics console.","text":"If you choose to collect contact information it is strongly recommend that you disclose this in your apps privacy policy.\n\n#### Example\n\n```js\nawait firebase.crashlytics().setUserName('Alias');\n```\n"},"parameters":[{"id":858,"name":"userName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A string representing an end-user's name or app username\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":160,"character":15}]}],"groups":[{"title":"Properties","kind":1024,"children":[875,844]},{"title":"Methods","kind":2048,"children":[845,847,850,862,866,872,859,853,856]}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":68,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":842,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":53,"character":26}]}],"groups":[{"title":"Classes","kind":128,"children":[843]},{"title":"Interfaces","kind":256,"children":[842]}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":50,"character":41}]},{"id":886,"name":"FirebaseDatabaseTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Database package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `database` package:\n\n```js\nimport { firebase } from '@react-native-firebase/database';\n\n// firebase.database().X\n```\n\n#### Example 2\n\nUsing the default export from the `database` package:\n\n```js\nimport database from '@react-native-firebase/database';\n\n// database().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/database';\n\n// firebase.database().X\n```\n","tags":[{"tag":"firebase","text":"database\n"}]},"children":[{"id":1185,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Database service is available for the default app or a given app.","text":"#### Example 1\n\nGet the database instance for the **default app**:\n\n```js\nconst databaseForDefaultApp = firebase.database();\n```\n\n#### Example 2\n\nGet the database instance for a **secondary app**:\n\n```js\nconst otherApp = firebase.app('otherApp');\nconst databaseForOtherApp = firebase.database(otherApp);\n```\n\n"},"children":[{"id":1207,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":1186,"name":"getServerTime","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1187,"name":"getServerTime","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the current Firebase Database server time as a JavaScript Date object."},"type":{"type":"reference","name":"Date"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1085,"character":17}]},{"id":1196,"name":"goOffline","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1197,"name":"goOffline","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Disconnects from the server (all Database operations will be completed offline).","text":"The client automatically maintains a persistent connection to the Database server, which\nwill remain active indefinitely and reconnect when disconnected. However, the `goOffline()` and\n`goOnline()` methods may be used to control the client connection in cases where a persistent\nconnection is undesirable.\n\nWhile offline, the client will no longer receive data updates from the Database. However,\nall Database operations performed locally will continue to immediately fire events, allowing\nyour application to continue behaving normally. Additionally, each operation performed locally\nwill automatically be queued and retried upon reconnection to the Database server.\n\nTo reconnect to the Database and begin receiving remote events, see `goOnline()`.\n\n#### Example\n\n```js\nawait firebase.database().goOnline();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1159,"character":13}]},{"id":1194,"name":"goOnline","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1195,"name":"goOnline","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Reconnects to the server and synchronizes the offline Database state with the server state.","text":"This method should be used after disabling the active connection with `goOffline()`. Once\nreconnected, the client will transmit the proper data and fire the appropriate events so that\nyour client \"catches up\" automatically.\n\n#### Example\n\n```js\nawait firebase.database().goOnline();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1136,"character":12}]},{"id":1188,"name":"ref","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1189,"name":"ref","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a `Reference` representing the location in the Database corresponding to the provided path.\nIf no path is provided, the Reference will point to the root of the Database.","text":"#### Example\n\n```js\n// Get a reference to the root of the Database\nconst rootRef = firebase.database().ref();\n\n// Get a reference to the /users/ada node\nconst adaRef = firebase.database().ref(\"users/ada\");\n```\n"},"parameters":[{"id":1190,"name":"path","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional path representing the location the returned `Reference` will point. If not provided, the returned `Reference` will point to the root of the Database.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Reference","id":894}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1103,"character":7}]},{"id":1191,"name":"refFromURL","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1192,"name":"refFromURL","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a `Reference` representing the location in the Database corresponding to the provided Firebase URL.","text":"An exception is thrown if the URL is not a valid Firebase Database URL or it has a different domain than the current Database instance.\n\nNote that all query parameters (orderBy, limitToLast, etc.) are ignored and are not applied to the returned Reference.\n\n#### Example\n\n```js\n// Get a reference to the root of the Database\nconst rootRef = firebase.database().ref(\"https://<DATABASE_NAME>.firebaseio.com\");\n```\n"},"parameters":[{"id":1193,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The Firebase URL at which the returned Reference will point.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Reference","id":894}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1121,"character":14}]},{"id":1201,"name":"setLoggingEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1202,"name":"setLoggingEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the native logging level for the database module. By default,\nonly warnings and errors are logged natively. Setting this to true will log all\ndatabase events.","text":"> Ensure logging is disabled for production apps, as excessive logging can cause performance issues.\n\n#### Example\n\n```js\n// Set debug logging if developing\nif (__DEV__) {\n  firebase.database().setLoggingEnabled(true);\n}\n```\n"},"parameters":[{"id":1203,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Whether debug logging is enabled.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1201,"character":21}]},{"id":1204,"name":"setPersistenceCacheSizeBytes","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1205,"name":"setPersistenceCacheSizeBytes","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"By default Firebase Database will use up to 10MB of disk space to cache data. If the cache grows beyond this size,\nFirebase Database will start removing data that hasn't been recently used. If you find that your application\ncaches too little or too much data, call this method to change the cache size. This method must be called before\ncreating your first Database reference and only needs to be called once per application.","text":"Note that the specified cache size is only an approximation and the size on disk may temporarily exceed it at times.\nCache sizes smaller than 1 MB or greater than 100 MB are not supported.\n\n#### Example\n\n```js\nfirebase.database().setPersistenceEnabled(true);\nfirebase.database().setPersistenceCacheSizeBytes(2000000); // 2MB\n\nasync function bootstrap() {\n  // Bootstrapping application\n  const snapshot = await firebase.database().ref('settings').once('value');\n}\n```\n"},"parameters":[{"id":1206,"name":"bytes","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new size of the cache in bytes.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1226,"character":32}]},{"id":1198,"name":"setPersistenceEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1199,"name":"setPersistenceEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets whether persistence is enabled for all database calls for the current app\ninstance.","text":"> Ensure this is called before any database calls are performed, otherwise\npersistence will only come into effect when the app is next started.\n\n#### Example\n\n```js\nfirebase.database().setPersistenceEnabled(true);\n\nasync function bootstrap() {\n  // Bootstrapping application\n  const snapshot = await firebase.database().ref('settings').once('value');\n}\n```\n"},"parameters":[{"id":1200,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Whether persistence is enabled for the Database service.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1181,"character":25}]}],"groups":[{"title":"Properties","kind":1024,"children":[1207]},{"title":"Methods","kind":2048,"children":[1186,1196,1194,1188,1191,1201,1204,1198]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1081,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":1159,"name":"DataSnapshot","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `DataSnapshot` contains data from a Database location.","text":"Any time you read data from the Database, you receive the data as a `DataSnapshot`. A `DataSnapshot`\nis passed to the event callbacks you attach with `on()` or `once()`. You can extract the contents\nof the snapshot as a JavaScript object by calling the val() method. Alternatively, you can traverse\ninto the snapshot by calling `child()` to return child snapshots (which you could then call `val()` on).\n"},"children":[{"id":1160,"name":"key","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The key (last part of the path) of the location of this `DataSnapshot`.","text":"The last token in a Database location is considered its key. For example, \"ada\" is the key\nfor the /users/ada/ node. Accessing the key on any `DataSnapshot` will return the key for the\nlocation that generated it. However, accessing the key on the root URL of a Database will return `null`.\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":923,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":1161,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Reference for the location that generated this `DataSnapshot`."},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":928,"character":7}],"type":{"type":"reference","name":"Reference","id":894}},{"id":1162,"name":"child","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1163,"name":"child","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets another `DataSnapshot` for the location at the specified relative path.","text":"Passing a relative path to the `child()` method of a DataSnapshot returns another `DataSnapshot`\nfor the location at the specified relative path. The relative path can either be a simple child\nname (for example, \"ada\") or a deeper, slash-separated path (for example, \"ada/name/first\").\nIf the child location has no data, an empty `DataSnapshot` (that is, a `DataSnapshot` whose value\nis `null`) is returned.\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users/ada').once('value');\nsnapshot.child('name').val(); // {first:\"Ada\",last:\"Lovelace\"}\nsnapshot.child('name/first').val(); // \"Ada\"\nsnapshot.child('name/foo').val(); // null\n```\n"},"parameters":[{"id":1164,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A relative path to the location of child data.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"DataSnapshot","id":1159}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":950,"character":9}]},{"id":1165,"name":"exists","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1166,"name":"exists","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `DataSnapshot` contains any data. It is slightly more efficient than using snapshot.val() !== null.","text":"#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users/ada').once('value');\nsnapshot.exists(); // true\nsnapshot.child('name/foo').exists(); // false\n```\n"},"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":963,"character":10}]},{"id":1167,"name":"exportVal","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1168,"name":"exportVal","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Exports the entire contents of the DataSnapshot as a JavaScript object.","text":"The `exportVal()` method is similar to val(), except priority information is included (if available),\nmaking it suitable for backing up your data.\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users/ada').once('value');\nconst data = snapshot.exportVal();\nconsole.log(data['.value']); // { ... }\nconsole.log(data['.priority']); // null\n```\n"},"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":980,"character":13}]},{"id":1169,"name":"forEach","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1170,"name":"forEach","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Enumerates the top-level children in the `DataSnapshot`.","text":"Because of the way JavaScript objects work, the ordering of data in the JavaScript object\nreturned by `val()` is not guaranteed to match the ordering on the server nor the ordering\nof `child_added` events. That is where `forEach()` comes in handy. It guarantees the children of\na DataSnapshot will be iterated in their query order.\n\nIf no explicit `orderBy*()` method is used, results are returned ordered by key (unless priorities are used, in which case, results are returned by priority).\n"},"parameters":[{"id":1171,"name":"action","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A function that will be called for each child DataSnapshot. The callback can return true to cancel further enumeration.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":994,"character":11}]},{"id":1172,"name":"getPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1173,"name":"getPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the priority value of the data in this DataSnapshot."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":999,"character":15}]},{"id":1174,"name":"hasChild","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1175,"name":"hasChild","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if the specified child path has (non-null) data.","text":"#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users/ada').once('value');\nconsole.log(snapshot.hasChild('name')); // true\nconsole.log(snapshot.hasChild('foo')); // false\n```\n"},"parameters":[{"id":1176,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A relative path to the location of a potential child.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1014,"character":12}]},{"id":1177,"name":"hasChildren","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1178,"name":"hasChildren","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns whether or not the `DataSnapshot` has any non-null child properties.","text":"You can use `hasChildren()` to determine if a `DataSnapshot` has any children. If it does, you\ncan enumerate them using `forEach()`. If it doesn't, then either this snapshot contains a primitive\nvalue (which can be retrieved with `val()`) or it is empty (in which case, `val()` will return null).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').once('value');\nconsole.log(snapshot.hasChildren()); // true\n```\n"},"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1030,"character":15}]},{"id":1179,"name":"numChildren","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1180,"name":"numChildren","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the number of child properties of this DataSnapshot."},"type":{"type":"intrinsic","name":"number"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1035,"character":15}]},{"id":1181,"name":"toJSON","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1182,"name":"toJSON","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a JSON-serializable representation of this object."},"type":{"type":"union","types":[{"type":"intrinsic","name":"object"},{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1040,"character":10}]},{"id":1183,"name":"val","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1184,"name":"val","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Extracts a JavaScript value from a `DataSnapshot`.","text":"Depending on the data in a DataSnapshot, the `val()` method may return a scalar type (string,\nnumber, or boolean), an array, or an object. It may also return null, indicating that the\n`DataSnapshot` is empty (contains no data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users/ada/last').once('value');\nsnapshot.val(); // \"Lovelace\"\n```\n"},"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1056,"character":7}]}],"groups":[{"title":"Properties","kind":1024,"children":[1160,1161]},{"title":"Methods","kind":2048,"children":[1162,1165,1167,1169,1172,1174,1177,1179,1181,1183]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":915,"character":31}]},{"id":1136,"name":"OnDisconnect","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The `onDisconnect` class allows you to write or clear data when your client disconnects from the Database server.\nThese updates occur whether your client disconnects cleanly or not, so you can rely on them to clean up data\neven if a connection is dropped or a client crashes.","text":"The onDisconnect class is most commonly used to manage presence in applications where it is\nuseful to detect how many clients are connected and when other clients disconnect.\n\nTo avoid problems when a connection is dropped before the requests can be transferred to the Database\nserver, these functions should be called before writing any data.\n\nNote that `onDisconnect` operations are only triggered once. If you want an operation to occur each time a\ndisconnect occurs, you'll need to re-establish the `onDisconnect` operations each time you reconnect.\n"},"children":[{"id":1137,"name":"cancel","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1138,"name":"cancel","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Cancels all previously queued `onDisconnect()` set or update events for this location and all children.","text":"If a write has been queued for this location via a `set()` or `update()` at a parent location,\nthe write at this location will be canceled, though writes to sibling locations will still occur.\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('onlineState');\nawait ref.onDisconnect().set(false);\n// Sometime later...\nawait ref.onDisconnect().cancel();\n```\n"},"parameters":[{"id":1139,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback function that will be called when synchronization to the server has completed. The callback will be passed a single parameter: null for success, or an Error object indicating a failure.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":826,"character":10}]},{"id":1140,"name":"remove","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1141,"name":"remove","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Ensures the data at this location is deleted when the client is disconnected (due to closing the browser, navigating to a new page, or network issues)."},"parameters":[{"id":1142,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback function that will be called when synchronization to the server has completed. The callback will be passed a single parameter: null for success, or an Error object indicating a failure.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":833,"character":10}]},{"id":1143,"name":"set","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1144,"name":"set","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Ensures the data at this location is set to the specified value when the client is disconnected\n(due to closing the app, navigating to a new view, or network issues).","text":"`set()` is especially useful for implementing \"presence\" systems, where a value should be changed\nor cleared when a user disconnects so that they appear \"offline\" to other users.\n\nNote that `onDisconnect` operations are only triggered once. If you want an operation to occur each time a\ndisconnect occurs, you'll need to re-establish the `onDisconnect` operations each time.\n\n#### Example\n\n```js\nvar ref = firebase.database().ref('users/ada/status');\nawait ref.onDisconnect().set('I disconnected!');\n```\n"},"parameters":[{"id":1145,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to be written to this location on disconnect (can be an object, array, string, number, boolean, or null)."},"type":{"type":"intrinsic","name":"any"}},{"id":1146,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback function that will be called when synchronization to the Database server has completed. The callback will be passed a single parameter: null for success, or an Error object indicating a failure.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":855,"character":7}]},{"id":1147,"name":"setWithPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1148,"name":"setWithPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Ensures the data at this location is set to the specified value and priority when the client is disconnected (due to closing the browser, navigating to a new page, or network issues)."},"parameters":[{"id":1149,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to set."},"type":{"type":"intrinsic","name":"any"}},{"id":1150,"name":"priority","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The priority to set"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}},{"id":1151,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback function that will be called when synchronization to the Database server has completed. The callback will be passed a single parameter: null for success, or an Error object indicating a failure.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":864,"character":19}]},{"id":1152,"name":"update","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1153,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes multiple values at this location when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).","text":"The `values` argument contains multiple property-value pairs that will be written to the Database together.\nEach child property can either be a simple property (for example, \"name\") or a relative path (for example,\n\"name/first\") from the current location to the data to update.\n\nAs opposed to the `set()` method, `update()` can be use to selectively update only the referenced\nproperties at the current location (instead of replacing all the child properties at the current location).\n\n#### Example\n\n```js\nvar ref = firebase.database().ref(\"users/ada\");\nref.update({\n  onlineState: true,\n  status: \"I'm online.\"\n});\nref.onDisconnect().update({\n  onlineState: false,\n  status: \"I'm offline.\"\n});\n```\n"},"parameters":[{"id":1154,"name":"values","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Object containing multiple values."},"type":{"type":"reflection","declaration":{"id":1155,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1156,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1157,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":897,"character":18}]}}},{"id":1158,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback function that will be called when synchronization to the server has completed. The callback will be passed a single parameter: null for success, or an Error object indicating a failure.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":897,"character":10}]}],"groups":[{"title":"Methods","kind":2048,"children":[1137,1140,1143,1147,1152]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":808,"character":31}]},{"id":1082,"name":"Query","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A Query sorts and filters the data at a Database location so only a subset of the child data\nis included. This can be used to order a collection of data by some attribute (for example,\nheight of dinosaurs) as well as to restrict a large list of items (for example, chat messages)\ndown to a number suitable for synchronizing to the client. Queries are created by chaining\ntogether one or more of the filter methods defined here.","text":"Just as with a `Reference`, you can receive data from a Query by using the on() method. You will\nonly receive events and `DataSnapshot`s for the subset of the data that matches your query.\n"},"children":[{"id":1083,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a Reference to the Query's location."},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":423,"character":7}],"type":{"type":"reference","name":"Reference","id":894}},{"id":1084,"name":"endAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1085,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Query with the specified ending point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe ending point is inclusive, so children with exactly the specified value will be included\nin the query. The optional key argument can be used to further limit the range of the query.\nIf it is specified, then children that have exactly the specified value must also have a key\nname less than or equal to the specified key.\n\nYou can read more about endAt() in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nconst snapshot = await ref.orderByKey().endAt('Ada Lovelace').once('value');\n```\n"},"parameters":[{"id":1086,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to end at. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":1087,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":448,"character":9}]},{"id":1088,"name":"equalTo","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1089,"name":"equalTo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Query with the specified ending point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe optional key argument can be used to further limit the range of the query. If it is\nspecified, then children that have exactly the specified value must also have exactly the\nspecified key as their key name. This can be used to filter result sets with many matches for the same value.\n\nYou can read more about equalTo() in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nconst snapshot = await ref.orderByChild('age').equalTo(30).once('value');\n```\n"},"parameters":[{"id":1090,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to match for. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":1091,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":472,"character":11}]},{"id":1092,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1093,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns whether or not the current and provided queries represent the same location, have the same query parameters.","text":"Two Reference objects are equivalent if they represent the same location and are from the same instance of\n{@link app}.  Equivalent queries share the same sort order, limits, and starting and ending points.\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref('users').orderByKey().endAt('Ada Lovelace');\nconst ref2 = firebase.database().ref('users').orderByKey();\n\nconsole.log(ref1.isEqual(ref2)); // false\n```\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref('users').orderByKey().endAt('Ada Lovelace');\nconst ref2 = firebase.database().ref('users').endAt('Ada Lovelace').orderByKey();\n\nconsole.log(ref1.isEqual(ref2)); // true\n```\n"},"parameters":[{"id":1094,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The query to compare against.\n"},"type":{"type":"reference","name":"Query","id":1082}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":500,"character":11}]},{"id":1133,"name":"keepSynced","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1134,"name":"keepSynced","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"By calling `keepSynced(true)` on a location, the data for that location will automatically\nbe downloaded and kept in sync, even when no listeners are attached for that location.","text":"#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nawait ref.keepSynced(true);\n```\n"},"parameters":[{"id":1135,"name":"bool","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Pass `true` to keep this location synchronized, pass `false` to stop synchronization.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":791,"character":14}]},{"id":1095,"name":"limitToFirst","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1096,"name":"limitToFirst","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` limited to the first specific number of children.","text":"The `limitToFirst()` method is used to set a maximum number of children to be synced for a\ngiven callback. If we set a limit of 100, we will initially only receive up to 100 `child_added`\nevents. If we have fewer than 100 messages stored in our Database, a child_added event will\nfire for each message. However, if we have over 100 messages, we will only receive a `child_added`\nevent for the first 100 ordered messages. As items change, we will receive `child_removed` events\nfor each item that drops out of the active list so that the total number stays at 100.\n\nYou can read more about `limitToFirst()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst snapshot = firebase.database().ref('users').orderByKey().limitToFirst(2).once('value');\nconsole.log(snapshot.numChildren()); // 2\n```\n"},"parameters":[{"id":1097,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of nodes to include in this query.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":523,"character":16}]},{"id":1098,"name":"limitToLast","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1099,"name":"limitToLast","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object limited to the last specific number of children.","text":"The `limitToLast()` method is used to set a maximum number of children to be synced for a given\ncallback. If we set a limit of 100, we will initially only receive up to 100 `child_added` events.\nIf we have fewer than 100 messages stored in our Database, a `child_added` event will fire for\neach message. However, if we have over 100 messages, we will only receive a `child_added` event\nfor the last 100 ordered messages. As items change, we will receive `child_removed` events for\neach item that drops out of the active list so that the total number stays at 100.\n\nYou can read more about `limitToLast()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst snapshot = firebase.database().ref('users').orderByKey().limitToLast(2).once('value');\nconsole.log(snapshot.numChildren()); // 2\n```\n"},"parameters":[{"id":1100,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of nodes to include in this query.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":546,"character":15}]},{"id":1101,"name":"off","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1102,"name":"off","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detaches a callback previously attached with `on()`.","text":"Detach a callback previously attached with `on()`. Note that if `on()` was called multiple times\nwith the same eventType and callback, the callback will be called multiple times for each\nevent, and `off()` must be called multiple times to remove the callback. Calling `off()` on a parent\nlistener will not automatically remove listeners registered on child nodes, `off()` must also be\ncalled on any child listeners to remove the callback.\n\nIf a callback is not specified, all callbacks for the specified eventType will be removed.\nSimilarly, if no eventType is specified, all callbacks for the `Reference` will be removed.\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('settings');\nconst onValueChange = function(snapshot) { ... };\nconst onChildAdded = function(snapshot) { ... };\n\nref.on('value', onValueChange);\nref.child('meta-data').on('child_added', onChildAdded);\n// Sometime later...\nref.off('value', onValueChange);\nref.child('meta-data').off('child_added', onChildAdded);\n```\n"},"parameters":[{"id":1103,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\" If omitted, all callbacks for the Reference will be removed."},"type":{"type":"reference","name":"EventType","id":1208}},{"id":1104,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The callback function that was passed to `on()` or `undefined` to remove all callbacks."},"type":{"type":"reference","name":"Function"}},{"id":1105,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The context that was passed to `on()`.\n"},"type":{"type":"reference","name":"Object"}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":578,"character":7}]},{"id":1106,"name":"on","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1107,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listens for data changes at a particular location.","text":"This is the primary way to read data from a Database. Your callback will be triggered for the\ninitial data and again whenever the data changes. Use `off()` to stop receiving updates..\n\n**value** event\n\nThis event will trigger once with the initial data stored at this location, and then trigger\nagain each time the data changes. The `DataSnapshot` passed to the callback will be for the location\nat which on() was called. It won't trigger until the entire contents has been synchronized.\nIf the location has no data, it will be triggered with an empty `DataSnapshot`\n(`val()` will return `null`).\n\n**child_added** event\n\nThis event will be triggered once for each initial child at this location, and it will be\ntriggered again every time a new child is added. The `DataSnapshot` passed into the callback\nwill reflect the data for the relevant child. For ordering purposes, it is passed a second argument\nwhich is a string containing the key of the previous sibling child by sort order, or `null` if\nit is the first child.\n\n**child_removed** event\n\nThis event will be triggered once every time a child is removed. The `DataSnapshot` passed into\nthe callback will be the old data for the child that was removed. A child will get removed when either:\n- a client explicitly calls `remove()` on that child or one of its ancestors\n- a client calls `set(null)` on that child or one of its ancestors\n- that child has all of its children removed\n- there is a query in effect which now filters out the child (because it's sort order changed or the max limit was hit)\n\n**child_changed** event\n\nThis event will be triggered when the data stored in a child (or any of its descendants) changes.\nNote that a single `child_changed` event may represent multiple changes to the child. The\n`DataSnapshot` passed to the callback will contain the new child contents. For ordering purposes,\nthe callback is also passed a second argument which is a string containing the key of the previous\nsibling child by sort order, or `null` if it is the first child.\n\n**child_moved** event\n\nThis event will be triggered when a child's sort order changes such that its position relative\nto its siblings changes. The `DataSnapshot` passed to the callback will be for the data of the child\nthat has moved. It is also passed a second argument which is a string containing the key of the\nprevious sibling child by sort order, or `null` if it is the first child.\n"},"parameters":[{"id":1108,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\""},"type":{"type":"reference","name":"EventType","id":1208}},{"id":1109,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback that fires when the specified event occurs. The callback will be passed a DataSnapshot. For ordering purposes, \"child_added\", \"child_changed\", and \"child_moved\" will also be passed a string containing the key of the previous child, by sort order, or `null` if it is the first child."},"type":{"type":"reference","name":"Function"}},{"id":1110,"name":"cancelCallbackOrContext","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback that will be notified if your event subscription is ever canceled because your client does not have permission to read this data (or it had permission but has now lost it). This callback will be passed an `Error` object indicating why the failure occurred."},"type":{"type":"reference","name":"Object"}},{"id":1111,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"If provided, this object will be used as `this` when calling your callback(s).\n\n"},"type":{"type":"union","types":[{"type":"reference","name":"Object"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Function"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":632,"character":6}]},{"id":1112,"name":"once","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1113,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listens for exactly one event of the specified event type, and then stops listening.","text":"This is equivalent to calling `on()`, and then calling `off()` inside the callback function. See `on()` for details on the event types.\n\n#### Example\n\n```js\n// Promise\nconst snapshot = await firebase.database().ref('users').once('value');\n// Callback\nfirebase.database().ref('users).once('value', (snapshot) => {\n  console.log(snapshot.val());\n});\n```\n"},"parameters":[{"id":1114,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\""},"type":{"type":"reference","name":"EventType","id":1208}},{"id":1115,"name":"successCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback that fires when the specified event occurs. The callback will be passed a DataSnapshot. For ordering purposes, \"child_added\", \"child_changed\", and \"child_moved\" will also be passed a string containing the key of the previous child by sort order, or `null` if it is the first child.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"DataSnapshot","id":1159}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":658,"character":8}]},{"id":1116,"name":"orderByChild","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1117,"name":"orderByChild","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by the specified child key.","text":"Queries can only order by one key at a time. Calling `orderByChild()` multiple times on the same query is an error.\n\nFirebase queries allow you to order your data by any child key on the fly. However, if you know in advance what\nyour indexes will be, you can define them via the [.indexOn](https://firebase.google.com/docs/database/security/indexing-data?authuser=0)\nrule in your Security Rules for better performance.\n\nYou can read more about orderByChild() in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').orderByChild('age').once('value');\nsnapshot.forEach((snapshot) => {\n console.log('Users age:', snapshot.val().age);\n});\n```\n"},"parameters":[{"id":1118,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The child path node to order by.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":682,"character":16}]},{"id":1119,"name":"orderByKey","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1120,"name":"orderByKey","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by key.","text":"Sorts the results of a query by their (ascending) key values.\n\nYou can read more about `orderByKey()` in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').orderByKey().once('value');\nsnapshot.forEach((snapshot) => {\n console.log('User:', snapshot.val());\n});\n```\n"},"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":700,"character":14}]},{"id":1121,"name":"orderByPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1122,"name":"orderByPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new Query object ordered by priority.","text":"Applications need not use priority but can order collections by ordinary properties\n(see [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data)\nfor alternatives to priority).\n"},"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":709,"character":19}]},{"id":1123,"name":"orderByValue","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1124,"name":"orderByValue","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by value.","text":"If the children of a query are all scalar values (string, number, or boolean), you can order\nthe results by their (ascending) values.\n\nYou can read more about `orderByValue()` in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nawait firebase.database().ref('scores').orderByValue().once('value');\n```\n"},"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":725,"character":16}]},{"id":1125,"name":"startAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1126,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a `Query` with the specified starting point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe starting point is inclusive, so children with exactly the specified value will be included\nin the query. The optional key argument can be used to further limit the range of the query.\nIf it is specified, then children that have exactly the specified value must also have a key\nname greater than or equal to the specified key.\n\nYou can read more about `startAt()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nawait firebase.database().ref('users').orderByChild('age').startAt(21).once('value');\n```\n"},"parameters":[{"id":1127,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to start at. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":1128,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to start at. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":749,"character":11}]},{"id":1129,"name":"toJSON","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1130,"name":"toJSON","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a JSON-serializable representation of this object."},"type":{"type":"intrinsic","name":"object"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":754,"character":10}]},{"id":1131,"name":"toString","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1132,"name":"toString","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the absolute URL for this location.","text":"The `toString()` method returns a URL that is ready to be put into a browser, curl command, or\na `firebase.database().refFromURL()` call. Since all of those expect the URL to be url-encoded,\n`toString()` returns an encoded URL.\n\nAppend '.json' to the returned URL when typed into a browser to download JSON-formatted data.\nIf the location is secured (that is, not publicly readable), you will get a permission-denied error.\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref();\nconst ref2 = firebase.database().ref('users').orderByValue();\n\nref1.toString(); // https://sample-app.firebaseio.com/\nref2.toString(); // https://sample-app.firebaseio.com/users\n```\n"},"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":776,"character":12}]}],"groups":[{"title":"Properties","kind":1024,"children":[1083]},{"title":"Methods","kind":2048,"children":[1084,1088,1092,1133,1095,1098,1101,1106,1112,1116,1119,1121,1123,1125,1129,1131]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":419,"character":24}],"extendedBy":[{"type":"reference","name":"Reference","id":894}]},{"id":894,"name":"Reference","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A Reference represents a specific location in your Database and can be used for reading or\nwriting data to that Database location.","text":"You can reference the root or child location in your Database by calling `firebase.database().ref()`\nor `firebase.database().ref(\"child/path\")`.\n"},"children":[{"id":900,"name":"key","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The last part of the Reference's path.\nFor example, \"ada\" is the key for https://<DATABASE_NAME>.firebaseio.com/users/ada.\nThe key of a root Reference is null."},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":159,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":895,"name":"parent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The parent location of a Reference. The parent of a root Reference is `null`.","text":"#### Example\n\n```js\nfirebase.database().ref().parent; // null\nfirebase.database().ref('users/dave').parent; // 'users' reference\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":123,"character":10}],"type":{"type":"union","types":[{"type":"reference","name":"Reference","id":894},{"type":"intrinsic","name":"null"}]}},{"id":935,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a Reference to the Query's location."},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":423,"character":7}],"type":{"type":"reference","name":"Reference","id":894},"inheritedFrom":{"type":"reference","name":"Query.ref","id":1083}},{"id":896,"name":"root","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The root Reference of the Database.","text":"#### Example\n\n```js\nfirebase.database().ref().root; // '/' reference path\nfirebase.database().ref('users/ada').root; // '/' reference\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":135,"character":8}],"type":{"type":"reference","name":"Reference","id":894}},{"id":897,"name":"child","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":898,"name":"child","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a Reference for the location at the specified relative path.","text":"The relative path can either be a simple child name (for example, \"ada\") or a deeper\nslash-separated path (for example, \"ada/name/first\").\n\n#### Example\n\n```js\nconst usersRef = firebase.database().ref('users');\nconst adaRef = usersRef.child('ada/name/first'); // childRef path is 'users/ada/name/first'\n```\n"},"parameters":[{"id":899,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A relative path from this location to the desired child location.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Reference","id":894}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":152,"character":9}]},{"id":936,"name":"endAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":937,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Query with the specified ending point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe ending point is inclusive, so children with exactly the specified value will be included\nin the query. The optional key argument can be used to further limit the range of the query.\nIf it is specified, then children that have exactly the specified value must also have a key\nname less than or equal to the specified key.\n\nYou can read more about endAt() in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nconst snapshot = await ref.orderByKey().endAt('Ada Lovelace').once('value');\n```\n"},"parameters":[{"id":938,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to end at. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":939,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1084}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":448,"character":9}],"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1084}},{"id":940,"name":"equalTo","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":941,"name":"equalTo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Query with the specified ending point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe optional key argument can be used to further limit the range of the query. If it is\nspecified, then children that have exactly the specified value must also have exactly the\nspecified key as their key name. This can be used to filter result sets with many matches for the same value.\n\nYou can read more about equalTo() in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nconst snapshot = await ref.orderByChild('age').equalTo(30).once('value');\n```\n"},"parameters":[{"id":942,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to match for. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":943,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.equalTo","id":1088}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":472,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.equalTo","id":1088}},{"id":944,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":945,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns whether or not the current and provided queries represent the same location, have the same query parameters.","text":"Two Reference objects are equivalent if they represent the same location and are from the same instance of\n{@link app}.  Equivalent queries share the same sort order, limits, and starting and ending points.\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref('users').orderByKey().endAt('Ada Lovelace');\nconst ref2 = firebase.database().ref('users').orderByKey();\n\nconsole.log(ref1.isEqual(ref2)); // false\n```\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref('users').orderByKey().endAt('Ada Lovelace');\nconst ref2 = firebase.database().ref('users').endAt('Ada Lovelace').orderByKey();\n\nconsole.log(ref1.isEqual(ref2)); // true\n```\n"},"parameters":[{"id":946,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The query to compare against.\n"},"type":{"type":"reference","name":"Query","id":1082}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","name":"Query.isEqual","id":1092}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":500,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.isEqual","id":1092}},{"id":985,"name":"keepSynced","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":986,"name":"keepSynced","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"By calling `keepSynced(true)` on a location, the data for that location will automatically\nbe downloaded and kept in sync, even when no listeners are attached for that location.","text":"#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nawait ref.keepSynced(true);\n```\n"},"parameters":[{"id":987,"name":"bool","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Pass `true` to keep this location synchronized, pass `false` to stop synchronization.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Query.keepSynced","id":1133}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":791,"character":14}],"inheritedFrom":{"type":"reference","name":"Query.keepSynced","id":1133}},{"id":947,"name":"limitToFirst","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":948,"name":"limitToFirst","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` limited to the first specific number of children.","text":"The `limitToFirst()` method is used to set a maximum number of children to be synced for a\ngiven callback. If we set a limit of 100, we will initially only receive up to 100 `child_added`\nevents. If we have fewer than 100 messages stored in our Database, a child_added event will\nfire for each message. However, if we have over 100 messages, we will only receive a `child_added`\nevent for the first 100 ordered messages. As items change, we will receive `child_removed` events\nfor each item that drops out of the active list so that the total number stays at 100.\n\nYou can read more about `limitToFirst()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst snapshot = firebase.database().ref('users').orderByKey().limitToFirst(2).once('value');\nconsole.log(snapshot.numChildren()); // 2\n```\n"},"parameters":[{"id":949,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of nodes to include in this query.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.limitToFirst","id":1095}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":523,"character":16}],"inheritedFrom":{"type":"reference","name":"Query.limitToFirst","id":1095}},{"id":950,"name":"limitToLast","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":951,"name":"limitToLast","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object limited to the last specific number of children.","text":"The `limitToLast()` method is used to set a maximum number of children to be synced for a given\ncallback. If we set a limit of 100, we will initially only receive up to 100 `child_added` events.\nIf we have fewer than 100 messages stored in our Database, a `child_added` event will fire for\neach message. However, if we have over 100 messages, we will only receive a `child_added` event\nfor the last 100 ordered messages. As items change, we will receive `child_removed` events for\neach item that drops out of the active list so that the total number stays at 100.\n\nYou can read more about `limitToLast()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst snapshot = firebase.database().ref('users').orderByKey().limitToLast(2).once('value');\nconsole.log(snapshot.numChildren()); // 2\n```\n"},"parameters":[{"id":952,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of nodes to include in this query.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.limitToLast","id":1098}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":546,"character":15}],"inheritedFrom":{"type":"reference","name":"Query.limitToLast","id":1098}},{"id":953,"name":"off","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":954,"name":"off","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detaches a callback previously attached with `on()`.","text":"Detach a callback previously attached with `on()`. Note that if `on()` was called multiple times\nwith the same eventType and callback, the callback will be called multiple times for each\nevent, and `off()` must be called multiple times to remove the callback. Calling `off()` on a parent\nlistener will not automatically remove listeners registered on child nodes, `off()` must also be\ncalled on any child listeners to remove the callback.\n\nIf a callback is not specified, all callbacks for the specified eventType will be removed.\nSimilarly, if no eventType is specified, all callbacks for the `Reference` will be removed.\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('settings');\nconst onValueChange = function(snapshot) { ... };\nconst onChildAdded = function(snapshot) { ... };\n\nref.on('value', onValueChange);\nref.child('meta-data').on('child_added', onChildAdded);\n// Sometime later...\nref.off('value', onValueChange);\nref.child('meta-data').off('child_added', onChildAdded);\n```\n"},"parameters":[{"id":955,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\" If omitted, all callbacks for the Reference will be removed."},"type":{"type":"reference","name":"EventType","id":1208}},{"id":956,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The callback function that was passed to `on()` or `undefined` to remove all callbacks."},"type":{"type":"reference","name":"Function"}},{"id":957,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The context that was passed to `on()`.\n"},"type":{"type":"reference","name":"Object"}}],"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","name":"Query.off","id":1101}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":578,"character":7}],"inheritedFrom":{"type":"reference","name":"Query.off","id":1101}},{"id":958,"name":"on","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":959,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listens for data changes at a particular location.","text":"This is the primary way to read data from a Database. Your callback will be triggered for the\ninitial data and again whenever the data changes. Use `off()` to stop receiving updates..\n\n**value** event\n\nThis event will trigger once with the initial data stored at this location, and then trigger\nagain each time the data changes. The `DataSnapshot` passed to the callback will be for the location\nat which on() was called. It won't trigger until the entire contents has been synchronized.\nIf the location has no data, it will be triggered with an empty `DataSnapshot`\n(`val()` will return `null`).\n\n**child_added** event\n\nThis event will be triggered once for each initial child at this location, and it will be\ntriggered again every time a new child is added. The `DataSnapshot` passed into the callback\nwill reflect the data for the relevant child. For ordering purposes, it is passed a second argument\nwhich is a string containing the key of the previous sibling child by sort order, or `null` if\nit is the first child.\n\n**child_removed** event\n\nThis event will be triggered once every time a child is removed. The `DataSnapshot` passed into\nthe callback will be the old data for the child that was removed. A child will get removed when either:\n- a client explicitly calls `remove()` on that child or one of its ancestors\n- a client calls `set(null)` on that child or one of its ancestors\n- that child has all of its children removed\n- there is a query in effect which now filters out the child (because it's sort order changed or the max limit was hit)\n\n**child_changed** event\n\nThis event will be triggered when the data stored in a child (or any of its descendants) changes.\nNote that a single `child_changed` event may represent multiple changes to the child. The\n`DataSnapshot` passed to the callback will contain the new child contents. For ordering purposes,\nthe callback is also passed a second argument which is a string containing the key of the previous\nsibling child by sort order, or `null` if it is the first child.\n\n**child_moved** event\n\nThis event will be triggered when a child's sort order changes such that its position relative\nto its siblings changes. The `DataSnapshot` passed to the callback will be for the data of the child\nthat has moved. It is also passed a second argument which is a string containing the key of the\nprevious sibling child by sort order, or `null` if it is the first child.\n"},"parameters":[{"id":960,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\""},"type":{"type":"reference","name":"EventType","id":1208}},{"id":961,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback that fires when the specified event occurs. The callback will be passed a DataSnapshot. For ordering purposes, \"child_added\", \"child_changed\", and \"child_moved\" will also be passed a string containing the key of the previous child, by sort order, or `null` if it is the first child."},"type":{"type":"reference","name":"Function"}},{"id":962,"name":"cancelCallbackOrContext","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback that will be notified if your event subscription is ever canceled because your client does not have permission to read this data (or it had permission but has now lost it). This callback will be passed an `Error` object indicating why the failure occurred."},"type":{"type":"reference","name":"Object"}},{"id":963,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"If provided, this object will be used as `this` when calling your callback(s).\n\n"},"type":{"type":"union","types":[{"type":"reference","name":"Object"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Function"},"inheritedFrom":{"type":"reference","name":"Query.on","id":1106}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":632,"character":6}],"inheritedFrom":{"type":"reference","name":"Query.on","id":1106}},{"id":933,"name":"onDisconnect","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":934,"name":"onDisconnect","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an {@link database.OnDisconnect} instance.","text":"#### Example\n\n```js\nconst userDisconnectRef = firebase.database().ref('users/ada/isOnline').onDisconnect();\n// When going offline\nawait userDisconnectRef.update(false);\n```\n"},"type":{"type":"reference","name":"OnDisconnect","id":1136}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":404,"character":16}]},{"id":964,"name":"once","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":965,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listens for exactly one event of the specified event type, and then stops listening.","text":"This is equivalent to calling `on()`, and then calling `off()` inside the callback function. See `on()` for details on the event types.\n\n#### Example\n\n```js\n// Promise\nconst snapshot = await firebase.database().ref('users').once('value');\n// Callback\nfirebase.database().ref('users).once('value', (snapshot) => {\n  console.log(snapshot.val());\n});\n```\n"},"parameters":[{"id":966,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\""},"type":{"type":"reference","name":"EventType","id":1208}},{"id":967,"name":"successCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback that fires when the specified event occurs. The callback will be passed a DataSnapshot. For ordering purposes, \"child_added\", \"child_changed\", and \"child_moved\" will also be passed a string containing the key of the previous child by sort order, or `null` if it is the first child.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"DataSnapshot","id":1159}]},"inheritedFrom":{"type":"reference","name":"Query.once","id":1112}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":658,"character":8}],"inheritedFrom":{"type":"reference","name":"Query.once","id":1112}},{"id":968,"name":"orderByChild","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":969,"name":"orderByChild","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by the specified child key.","text":"Queries can only order by one key at a time. Calling `orderByChild()` multiple times on the same query is an error.\n\nFirebase queries allow you to order your data by any child key on the fly. However, if you know in advance what\nyour indexes will be, you can define them via the [.indexOn](https://firebase.google.com/docs/database/security/indexing-data?authuser=0)\nrule in your Security Rules for better performance.\n\nYou can read more about orderByChild() in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').orderByChild('age').once('value');\nsnapshot.forEach((snapshot) => {\n console.log('Users age:', snapshot.val().age);\n});\n```\n"},"parameters":[{"id":970,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The child path node to order by.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByChild","id":1116}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":682,"character":16}],"inheritedFrom":{"type":"reference","name":"Query.orderByChild","id":1116}},{"id":971,"name":"orderByKey","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":972,"name":"orderByKey","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by key.","text":"Sorts the results of a query by their (ascending) key values.\n\nYou can read more about `orderByKey()` in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').orderByKey().once('value');\nsnapshot.forEach((snapshot) => {\n console.log('User:', snapshot.val());\n});\n```\n"},"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByKey","id":1119}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":700,"character":14}],"inheritedFrom":{"type":"reference","name":"Query.orderByKey","id":1119}},{"id":973,"name":"orderByPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":974,"name":"orderByPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new Query object ordered by priority.","text":"Applications need not use priority but can order collections by ordinary properties\n(see [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data)\nfor alternatives to priority).\n"},"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByPriority","id":1121}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":709,"character":19}],"inheritedFrom":{"type":"reference","name":"Query.orderByPriority","id":1121}},{"id":975,"name":"orderByValue","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":976,"name":"orderByValue","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by value.","text":"If the children of a query are all scalar values (string, number, or boolean), you can order\nthe results by their (ascending) values.\n\nYou can read more about `orderByValue()` in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nawait firebase.database().ref('scores').orderByValue().once('value');\n```\n"},"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByValue","id":1123}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":725,"character":16}],"inheritedFrom":{"type":"reference","name":"Query.orderByValue","id":1123}},{"id":929,"name":"push","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":930,"name":"push","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new child location using a unique key and returns its `Reference`.","text":"This is the most common pattern for adding data to a collection of items.\n\nIf you provide a value to `push()`, the value will be written to the generated location.\nIf you don't pass a value, nothing will be written to the Database and the child will\nremain empty (but you can use the `Reference` elsewhere).\n\nThe unique key generated by push() are ordered by the current time, so the resulting list\nof items will be chronologically sorted. The keys are also designed to be unguessable\n(they contain 72 random bits of entropy).\n\n#### Example\n\n```js\nconst newUserRef = firebase.database().ref('users').push();\nconsole.log('New record key:', newUserRef.key);\nawait newUserRef.set({\n  first: 'Ada',\n  last: 'Lovelace',\n});\n```\n"},"parameters":[{"id":931,"name":"value","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional value to be written at the generated location."},"type":{"type":"intrinsic","name":"any"}},{"id":932,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"ThenableReference","id":988}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":391,"character":8}]},{"id":921,"name":"remove","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":922,"name":"remove","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes the data at this Database location.","text":"Any data at child locations will also be deleted.\n\nThe effect of the remove will be visible immediately and the corresponding event 'value' will be triggered.\nSynchronization of the remove to the Firebase servers will also be started, and the returned Promise will\nresolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization\nhas finished.\n\n#### Example\n\n```js\nawait firebase.database().ref('users/ada/name')\n .remove(() => {\n   console.log('Operation Complete');\n });\n```\n"},"parameters":[{"id":923,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":318,"character":10}]},{"id":901,"name":"set","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":902,"name":"set","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes data to this Database location.","text":"This will overwrite any data at this location and all child locations.\n\nThe effect of the write will be visible immediately, and the corresponding events\n(\"value\", \"child_added\", etc.) will be triggered. Synchronization of the data to the\nFirebase servers will also be started, and the returned Promise will resolve when\ncomplete. If provided, the `onComplete` callback will be called asynchronously after\nsynchronization has finished.\n\nPassing `null` for the new value is equivalent to calling `remove();` namely, all data at\nthis location and all child locations will be deleted.\n\n`set()` will remove any priority stored at this location, so if priority is meant to be\npreserved, you need to use `setWithPriority()` instead.\n\nNote that modifying data with set() will cancel any pending transactions at that location,\nso extreme care should be taken if mixing set() and transaction() to modify the same data.\n\nA single set() will generate a single \"value\" event at the location where the set() was performed.\n\n#### Example - Setting values\n\n```js\nconst ref = firebase.database().ref('users');\n\n// Set a single node value\nawait ref.child('ada/name/first').set('Ada');\nawait ref.child('ada/name/last').set('Lovelace');\n\n// Set an object value in a single call\nawait ref.child('ada/name').set({\n  first: 'Ada',\n  last: 'Lovelace',\n});\n```\n\n#### Example - On complete listener\n\n```js\nconst ref = firebase.database().ref('users');\n\nawait ref.child('ada/first/name').set('Ada', (error) => {\n  if (error) console.error(error);\n});\n```\n"},"parameters":[{"id":903,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to be written (string, number, boolean, object, array, or null)."},"type":{"type":"intrinsic","name":"any"}},{"id":904,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":212,"character":7}]},{"id":912,"name":"setPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":913,"name":"setPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a priority for the data at this Database location. Setting null removes any priority at this location.","text":"See {@link database.Query#orderByPriority} to learn how to use priority values in your query.\n\n#### Example\n\n```js\nawait firebase.database().ref('users/ada').setPriority(1, (error) => {\n  if (error) console.error(error);\n});\n```\n"},"parameters":[{"id":914,"name":"priority","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The priority value."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}},{"id":915,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":270,"character":15}]},{"id":916,"name":"setWithPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":917,"name":"setWithPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes data the Database location. Like `set()` but also specifies the priority for that data.","text":"#### Example\n\n```js\nawait firebase.database().ref('users/ada/name')\n .setWithPriority({\n   first: 'Ada',\n   last: 'Lovelace',\n }, 1, (error) => {\n   if (error) console.error(error);\n });\n```\n"},"parameters":[{"id":918,"name":"newVal","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new value to set."},"type":{"type":"intrinsic","name":"any"}},{"id":919,"name":"newPriority","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new priority to set."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}},{"id":920,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":291,"character":19}]},{"id":977,"name":"startAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":978,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a `Query` with the specified starting point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe starting point is inclusive, so children with exactly the specified value will be included\nin the query. The optional key argument can be used to further limit the range of the query.\nIf it is specified, then children that have exactly the specified value must also have a key\nname greater than or equal to the specified key.\n\nYou can read more about `startAt()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nawait firebase.database().ref('users').orderByChild('age').startAt(21).once('value');\n```\n"},"parameters":[{"id":979,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to start at. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":980,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to start at. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1125}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":749,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1125}},{"id":981,"name":"toJSON","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":982,"name":"toJSON","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a JSON-serializable representation of this object."},"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","name":"Query.toJSON","id":1129}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":754,"character":10}],"inheritedFrom":{"type":"reference","name":"Query.toJSON","id":1129}},{"id":983,"name":"toString","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":984,"name":"toString","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the absolute URL for this location.","text":"The `toString()` method returns a URL that is ready to be put into a browser, curl command, or\na `firebase.database().refFromURL()` call. Since all of those expect the URL to be url-encoded,\n`toString()` returns an encoded URL.\n\nAppend '.json' to the returned URL when typed into a browser to download JSON-formatted data.\nIf the location is secured (that is, not publicly readable), you will get a permission-denied error.\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref();\nconst ref2 = firebase.database().ref('users').orderByValue();\n\nref1.toString(); // https://sample-app.firebaseio.com/\nref2.toString(); // https://sample-app.firebaseio.com/users\n```\n"},"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"Query.toString","id":1131}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":776,"character":12}],"inheritedFrom":{"type":"reference","name":"Query.toString","id":1131}},{"id":924,"name":"transaction","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":925,"name":"transaction","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Atomically modifies the data at this location.","text":"Atomically modify the data at this location. Unlike a normal `set()`, which just overwrites\nthe data regardless of its previous value, `transaction()` is used to modify the existing\nvalue to a new value, ensuring there are no conflicts with other clients writing to the same\nlocation at the same time.\n\nTo accomplish this, you pass `transaction()` an update function which is used to transform the\ncurrent value into a new value. If another client writes to the location before your new\nvalue is successfully written, your update function will be called again with the new\ncurrent value, and the write will be retried. This will happen repeatedly until your write\nsucceeds without conflict or you abort the transaction by not returning a value from your\nupdate function.\n\nNote: Modifying data with `set()` will cancel any pending transactions at that location, so\nextreme care should be taken if mixing `set()` and `transaction()` to update the same data.\n\nNote: When using transactions with Security and Firebase Rules in place, be aware that a\nclient needs `.read` access in addition to `.write` access in order to perform a transaction.\nThis is because the client-side nature of transactions requires the client to read the data\nin order to transactionally update it.\n\n#### Example\n\n```js\nconst userRef = firebase.database().ref('users/ada/profileViews);\n\nuserRef.transaction((currentViews) => {\n  if (currentViews === null) return 1;\n  return currentViews + 1;\n});\n```\n"},"parameters":[{"id":926,"name":"transactionUpdate","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A developer-supplied function which will be passed the current data stored at this location (as a JavaScript object). The function should return the new value it would like written (as a JavaScript object). If undefined is returned (i.e. you return with no arguments) the transaction will be aborted and the data at this location will not be modified."},"type":{"type":"reference","name":"Function"}},{"id":927,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback function that will be called when the transaction completes. The callback is passed three arguments: a possibly-null Error, a boolean indicating whether the transaction was committed, and a DataSnapshot indicating the final result. If the transaction failed abnormally, the first argument will be an Error object indicating the failure cause. If the transaction finished normally, but no data was committed because no data was returned from transactionUpdate, then second argument will be false. If the transaction completed and committed data to Firebase, the second argument will be true. Regardless, the third argument will be a DataSnapshot containing the resulting data in this location."},"type":{"type":"reference","name":"Function"}},{"id":928,"name":"applyLocally","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"By default, events are raised each time the transaction update function runs. So if it is run multiple times, you may see intermediate states. You can set this to false to suppress these intermediate states and instead wait until the transaction has completed before events are raised.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"TransactionResult","id":891}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":358,"character":15}]},{"id":905,"name":"update","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":906,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes multiple values to the Database at once.","text":"The `values` argument contains multiple property-value pairs that will be written to the Database\ntogether. Each child property can either be a simple property (for example, \"name\") or a\nrelative path (for example, \"name/first\") from the current location to the data to update.\n\nAs opposed to the `set()` method, `update()` can be use to selectively update only the referenced\nproperties at the current location (instead of replacing all the child properties at the\ncurrent location).\n\nThe effect of the write will be visible immediately, and the corresponding events ('value',\n'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers\nwill also be started, and the returned Promise will resolve when complete. If provided, the\n`onComplete` callback will be called asynchronously after synchronization has finished.\n\nA single update() will generate a single \"value\" event at the location where the update()\nwas performed, regardless of how many children were modified.\n\nNote that modifying data with update() will cancel any pending transactions at that location,\nso extreme care should be taken if mixing update() and transaction() to modify the same data.\n\nPassing `null` to `update()` will remove the data at this location.\n\n#### Example\n\nModify the 'first' and 'last' properties, but leave other values unchanged at this location.\n\n```js\nawait firebase.database().ref('users/ada/name').update({\n  first: 'Ada',\n  last: 'Lovelace',\n})\n```\n"},"parameters":[{"id":907,"name":"values","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Object containing multiple values."},"type":{"type":"reflection","declaration":{"id":908,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":909,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":910,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":252,"character":18}]}}},{"id":911,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":252,"character":10}]}],"groups":[{"title":"Properties","kind":1024,"children":[900,895,935,896]},{"title":"Methods","kind":2048,"children":[897,936,940,944,985,947,950,953,958,933,964,968,971,973,975,929,921,901,912,916,977,981,983,924,905]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":112,"character":28}],"extendedTypes":[{"type":"reference","name":"Query","id":1082}],"extendedBy":[{"type":"reference","name":"ThenableReference","id":988}]},{"id":887,"name":"ServerValue","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The ServerValue interface provides access to Firebase server values."},"children":[{"id":888,"name":"TIMESTAMP","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A placeholder value for auto-populating the current timestamp (time since the Unix epoch,\nin milliseconds) as determined by the Firebase servers.","text":"#### Example\n\n```js\nfirebase.database().ref('sessions').push({\n  startedAt: firebase.database.ServerValue.TIMESTAMP,\n});\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":75,"character":13}],"type":{"type":"intrinsic","name":"object"}}],"groups":[{"title":"Properties","kind":1024,"children":[888]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":62,"character":30}]},{"id":889,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Realtime Database statics.","text":"#### Example\n\n```js\nfirebase.database;\n```\n"},"children":[{"id":890,"name":"ServerValue","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns server specific values, such as the server timestamp.","text":"#### Example\n\n```js\nfirebase.database.ServerValue;\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":97,"character":15}],"type":{"type":"reference","name":"ServerValue","id":887}}],"groups":[{"title":"Properties","kind":1024,"children":[890]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":87,"character":26}]},{"id":988,"name":"ThenableReference","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":994,"name":"key","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The last part of the Reference's path.\nFor example, \"ada\" is the key for https://<DATABASE_NAME>.firebaseio.com/users/ada.\nThe key of a root Reference is null."},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":159,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"Reference.key","id":900}},{"id":989,"name":"parent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The parent location of a Reference. The parent of a root Reference is `null`.","text":"#### Example\n\n```js\nfirebase.database().ref().parent; // null\nfirebase.database().ref('users/dave').parent; // 'users' reference\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":123,"character":10}],"type":{"type":"union","types":[{"type":"reference","name":"Reference","id":894},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"Reference.parent","id":895}},{"id":1029,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a Reference to the Query's location."},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":423,"character":7}],"type":{"type":"reference","name":"Reference","id":894},"inheritedFrom":{"type":"reference","name":"Query.ref","id":1083}},{"id":990,"name":"root","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The root Reference of the Database.","text":"#### Example\n\n```js\nfirebase.database().ref().root; // '/' reference path\nfirebase.database().ref('users/ada').root; // '/' reference\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":135,"character":8}],"type":{"type":"reference","name":"Reference","id":894},"inheritedFrom":{"type":"reference","name":"Reference.root","id":896}},{"id":991,"name":"child","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":992,"name":"child","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a Reference for the location at the specified relative path.","text":"The relative path can either be a simple child name (for example, \"ada\") or a deeper\nslash-separated path (for example, \"ada/name/first\").\n\n#### Example\n\n```js\nconst usersRef = firebase.database().ref('users');\nconst adaRef = usersRef.child('ada/name/first'); // childRef path is 'users/ada/name/first'\n```\n"},"parameters":[{"id":993,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A relative path from this location to the desired child location.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Reference","id":894},"inheritedFrom":{"type":"reference","name":"Reference.child","id":897}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":152,"character":9}],"inheritedFrom":{"type":"reference","name":"Reference.child","id":897}},{"id":1030,"name":"endAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1031,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Query with the specified ending point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe ending point is inclusive, so children with exactly the specified value will be included\nin the query. The optional key argument can be used to further limit the range of the query.\nIf it is specified, then children that have exactly the specified value must also have a key\nname less than or equal to the specified key.\n\nYou can read more about endAt() in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nconst snapshot = await ref.orderByKey().endAt('Ada Lovelace').once('value');\n```\n"},"parameters":[{"id":1032,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to end at. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":1033,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1084}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":448,"character":9}],"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1084}},{"id":1034,"name":"equalTo","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1035,"name":"equalTo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Query with the specified ending point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe optional key argument can be used to further limit the range of the query. If it is\nspecified, then children that have exactly the specified value must also have exactly the\nspecified key as their key name. This can be used to filter result sets with many matches for the same value.\n\nYou can read more about equalTo() in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nconst snapshot = await ref.orderByChild('age').equalTo(30).once('value');\n```\n"},"parameters":[{"id":1036,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to match for. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":1037,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.equalTo","id":1088}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":472,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.equalTo","id":1088}},{"id":1038,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1039,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns whether or not the current and provided queries represent the same location, have the same query parameters.","text":"Two Reference objects are equivalent if they represent the same location and are from the same instance of\n{@link app}.  Equivalent queries share the same sort order, limits, and starting and ending points.\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref('users').orderByKey().endAt('Ada Lovelace');\nconst ref2 = firebase.database().ref('users').orderByKey();\n\nconsole.log(ref1.isEqual(ref2)); // false\n```\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref('users').orderByKey().endAt('Ada Lovelace');\nconst ref2 = firebase.database().ref('users').endAt('Ada Lovelace').orderByKey();\n\nconsole.log(ref1.isEqual(ref2)); // true\n```\n"},"parameters":[{"id":1040,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The query to compare against.\n"},"type":{"type":"reference","name":"Query","id":1082}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","name":"Query.isEqual","id":1092}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":500,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.isEqual","id":1092}},{"id":1079,"name":"keepSynced","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1080,"name":"keepSynced","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"By calling `keepSynced(true)` on a location, the data for that location will automatically\nbe downloaded and kept in sync, even when no listeners are attached for that location.","text":"#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nawait ref.keepSynced(true);\n```\n"},"parameters":[{"id":1081,"name":"bool","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Pass `true` to keep this location synchronized, pass `false` to stop synchronization.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Query.keepSynced","id":1133}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":791,"character":14}],"inheritedFrom":{"type":"reference","name":"Query.keepSynced","id":1133}},{"id":1041,"name":"limitToFirst","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1042,"name":"limitToFirst","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` limited to the first specific number of children.","text":"The `limitToFirst()` method is used to set a maximum number of children to be synced for a\ngiven callback. If we set a limit of 100, we will initially only receive up to 100 `child_added`\nevents. If we have fewer than 100 messages stored in our Database, a child_added event will\nfire for each message. However, if we have over 100 messages, we will only receive a `child_added`\nevent for the first 100 ordered messages. As items change, we will receive `child_removed` events\nfor each item that drops out of the active list so that the total number stays at 100.\n\nYou can read more about `limitToFirst()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst snapshot = firebase.database().ref('users').orderByKey().limitToFirst(2).once('value');\nconsole.log(snapshot.numChildren()); // 2\n```\n"},"parameters":[{"id":1043,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of nodes to include in this query.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.limitToFirst","id":1095}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":523,"character":16}],"inheritedFrom":{"type":"reference","name":"Query.limitToFirst","id":1095}},{"id":1044,"name":"limitToLast","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1045,"name":"limitToLast","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object limited to the last specific number of children.","text":"The `limitToLast()` method is used to set a maximum number of children to be synced for a given\ncallback. If we set a limit of 100, we will initially only receive up to 100 `child_added` events.\nIf we have fewer than 100 messages stored in our Database, a `child_added` event will fire for\neach message. However, if we have over 100 messages, we will only receive a `child_added` event\nfor the last 100 ordered messages. As items change, we will receive `child_removed` events for\neach item that drops out of the active list so that the total number stays at 100.\n\nYou can read more about `limitToLast()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst snapshot = firebase.database().ref('users').orderByKey().limitToLast(2).once('value');\nconsole.log(snapshot.numChildren()); // 2\n```\n"},"parameters":[{"id":1046,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of nodes to include in this query.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.limitToLast","id":1098}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":546,"character":15}],"inheritedFrom":{"type":"reference","name":"Query.limitToLast","id":1098}},{"id":1047,"name":"off","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1048,"name":"off","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detaches a callback previously attached with `on()`.","text":"Detach a callback previously attached with `on()`. Note that if `on()` was called multiple times\nwith the same eventType and callback, the callback will be called multiple times for each\nevent, and `off()` must be called multiple times to remove the callback. Calling `off()` on a parent\nlistener will not automatically remove listeners registered on child nodes, `off()` must also be\ncalled on any child listeners to remove the callback.\n\nIf a callback is not specified, all callbacks for the specified eventType will be removed.\nSimilarly, if no eventType is specified, all callbacks for the `Reference` will be removed.\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('settings');\nconst onValueChange = function(snapshot) { ... };\nconst onChildAdded = function(snapshot) { ... };\n\nref.on('value', onValueChange);\nref.child('meta-data').on('child_added', onChildAdded);\n// Sometime later...\nref.off('value', onValueChange);\nref.child('meta-data').off('child_added', onChildAdded);\n```\n"},"parameters":[{"id":1049,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\" If omitted, all callbacks for the Reference will be removed."},"type":{"type":"reference","name":"EventType","id":1208}},{"id":1050,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The callback function that was passed to `on()` or `undefined` to remove all callbacks."},"type":{"type":"reference","name":"Function"}},{"id":1051,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The context that was passed to `on()`.\n"},"type":{"type":"reference","name":"Object"}}],"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","name":"Query.off","id":1101}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":578,"character":7}],"inheritedFrom":{"type":"reference","name":"Query.off","id":1101}},{"id":1052,"name":"on","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1053,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listens for data changes at a particular location.","text":"This is the primary way to read data from a Database. Your callback will be triggered for the\ninitial data and again whenever the data changes. Use `off()` to stop receiving updates..\n\n**value** event\n\nThis event will trigger once with the initial data stored at this location, and then trigger\nagain each time the data changes. The `DataSnapshot` passed to the callback will be for the location\nat which on() was called. It won't trigger until the entire contents has been synchronized.\nIf the location has no data, it will be triggered with an empty `DataSnapshot`\n(`val()` will return `null`).\n\n**child_added** event\n\nThis event will be triggered once for each initial child at this location, and it will be\ntriggered again every time a new child is added. The `DataSnapshot` passed into the callback\nwill reflect the data for the relevant child. For ordering purposes, it is passed a second argument\nwhich is a string containing the key of the previous sibling child by sort order, or `null` if\nit is the first child.\n\n**child_removed** event\n\nThis event will be triggered once every time a child is removed. The `DataSnapshot` passed into\nthe callback will be the old data for the child that was removed. A child will get removed when either:\n- a client explicitly calls `remove()` on that child or one of its ancestors\n- a client calls `set(null)` on that child or one of its ancestors\n- that child has all of its children removed\n- there is a query in effect which now filters out the child (because it's sort order changed or the max limit was hit)\n\n**child_changed** event\n\nThis event will be triggered when the data stored in a child (or any of its descendants) changes.\nNote that a single `child_changed` event may represent multiple changes to the child. The\n`DataSnapshot` passed to the callback will contain the new child contents. For ordering purposes,\nthe callback is also passed a second argument which is a string containing the key of the previous\nsibling child by sort order, or `null` if it is the first child.\n\n**child_moved** event\n\nThis event will be triggered when a child's sort order changes such that its position relative\nto its siblings changes. The `DataSnapshot` passed to the callback will be for the data of the child\nthat has moved. It is also passed a second argument which is a string containing the key of the\nprevious sibling child by sort order, or `null` if it is the first child.\n"},"parameters":[{"id":1054,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\""},"type":{"type":"reference","name":"EventType","id":1208}},{"id":1055,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback that fires when the specified event occurs. The callback will be passed a DataSnapshot. For ordering purposes, \"child_added\", \"child_changed\", and \"child_moved\" will also be passed a string containing the key of the previous child, by sort order, or `null` if it is the first child."},"type":{"type":"reference","name":"Function"}},{"id":1056,"name":"cancelCallbackOrContext","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback that will be notified if your event subscription is ever canceled because your client does not have permission to read this data (or it had permission but has now lost it). This callback will be passed an `Error` object indicating why the failure occurred."},"type":{"type":"reference","name":"Object"}},{"id":1057,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"If provided, this object will be used as `this` when calling your callback(s).\n\n"},"type":{"type":"union","types":[{"type":"reference","name":"Object"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Function"},"inheritedFrom":{"type":"reference","name":"Query.on","id":1106}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":632,"character":6}],"inheritedFrom":{"type":"reference","name":"Query.on","id":1106}},{"id":1027,"name":"onDisconnect","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1028,"name":"onDisconnect","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an {@link database.OnDisconnect} instance.","text":"#### Example\n\n```js\nconst userDisconnectRef = firebase.database().ref('users/ada/isOnline').onDisconnect();\n// When going offline\nawait userDisconnectRef.update(false);\n```\n"},"type":{"type":"reference","name":"OnDisconnect","id":1136},"inheritedFrom":{"type":"reference","name":"Reference.onDisconnect","id":933}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":404,"character":16}],"inheritedFrom":{"type":"reference","name":"Reference.onDisconnect","id":933}},{"id":1058,"name":"once","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1059,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listens for exactly one event of the specified event type, and then stops listening.","text":"This is equivalent to calling `on()`, and then calling `off()` inside the callback function. See `on()` for details on the event types.\n\n#### Example\n\n```js\n// Promise\nconst snapshot = await firebase.database().ref('users').once('value');\n// Callback\nfirebase.database().ref('users).once('value', (snapshot) => {\n  console.log(snapshot.val());\n});\n```\n"},"parameters":[{"id":1060,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\""},"type":{"type":"reference","name":"EventType","id":1208}},{"id":1061,"name":"successCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback that fires when the specified event occurs. The callback will be passed a DataSnapshot. For ordering purposes, \"child_added\", \"child_changed\", and \"child_moved\" will also be passed a string containing the key of the previous child by sort order, or `null` if it is the first child.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"DataSnapshot","id":1159}]},"inheritedFrom":{"type":"reference","name":"Query.once","id":1112}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":658,"character":8}],"inheritedFrom":{"type":"reference","name":"Query.once","id":1112}},{"id":1062,"name":"orderByChild","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1063,"name":"orderByChild","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by the specified child key.","text":"Queries can only order by one key at a time. Calling `orderByChild()` multiple times on the same query is an error.\n\nFirebase queries allow you to order your data by any child key on the fly. However, if you know in advance what\nyour indexes will be, you can define them via the [.indexOn](https://firebase.google.com/docs/database/security/indexing-data?authuser=0)\nrule in your Security Rules for better performance.\n\nYou can read more about orderByChild() in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').orderByChild('age').once('value');\nsnapshot.forEach((snapshot) => {\n console.log('Users age:', snapshot.val().age);\n});\n```\n"},"parameters":[{"id":1064,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The child path node to order by.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByChild","id":1116}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":682,"character":16}],"inheritedFrom":{"type":"reference","name":"Query.orderByChild","id":1116}},{"id":1065,"name":"orderByKey","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1066,"name":"orderByKey","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by key.","text":"Sorts the results of a query by their (ascending) key values.\n\nYou can read more about `orderByKey()` in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').orderByKey().once('value');\nsnapshot.forEach((snapshot) => {\n console.log('User:', snapshot.val());\n});\n```\n"},"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByKey","id":1119}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":700,"character":14}],"inheritedFrom":{"type":"reference","name":"Query.orderByKey","id":1119}},{"id":1067,"name":"orderByPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1068,"name":"orderByPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new Query object ordered by priority.","text":"Applications need not use priority but can order collections by ordinary properties\n(see [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data)\nfor alternatives to priority).\n"},"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByPriority","id":1121}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":709,"character":19}],"inheritedFrom":{"type":"reference","name":"Query.orderByPriority","id":1121}},{"id":1069,"name":"orderByValue","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1070,"name":"orderByValue","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by value.","text":"If the children of a query are all scalar values (string, number, or boolean), you can order\nthe results by their (ascending) values.\n\nYou can read more about `orderByValue()` in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nawait firebase.database().ref('scores').orderByValue().once('value');\n```\n"},"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByValue","id":1123}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":725,"character":16}],"inheritedFrom":{"type":"reference","name":"Query.orderByValue","id":1123}},{"id":1023,"name":"push","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1024,"name":"push","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new child location using a unique key and returns its `Reference`.","text":"This is the most common pattern for adding data to a collection of items.\n\nIf you provide a value to `push()`, the value will be written to the generated location.\nIf you don't pass a value, nothing will be written to the Database and the child will\nremain empty (but you can use the `Reference` elsewhere).\n\nThe unique key generated by push() are ordered by the current time, so the resulting list\nof items will be chronologically sorted. The keys are also designed to be unguessable\n(they contain 72 random bits of entropy).\n\n#### Example\n\n```js\nconst newUserRef = firebase.database().ref('users').push();\nconsole.log('New record key:', newUserRef.key);\nawait newUserRef.set({\n  first: 'Ada',\n  last: 'Lovelace',\n});\n```\n"},"parameters":[{"id":1025,"name":"value","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional value to be written at the generated location."},"type":{"type":"intrinsic","name":"any"}},{"id":1026,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"ThenableReference","id":988},"inheritedFrom":{"type":"reference","name":"Reference.push","id":929}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":391,"character":8}],"inheritedFrom":{"type":"reference","name":"Reference.push","id":929}},{"id":1015,"name":"remove","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1016,"name":"remove","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes the data at this Database location.","text":"Any data at child locations will also be deleted.\n\nThe effect of the remove will be visible immediately and the corresponding event 'value' will be triggered.\nSynchronization of the remove to the Firebase servers will also be started, and the returned Promise will\nresolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization\nhas finished.\n\n#### Example\n\n```js\nawait firebase.database().ref('users/ada/name')\n .remove(() => {\n   console.log('Operation Complete');\n });\n```\n"},"parameters":[{"id":1017,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Reference.remove","id":921}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":318,"character":10}],"inheritedFrom":{"type":"reference","name":"Reference.remove","id":921}},{"id":995,"name":"set","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":996,"name":"set","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes data to this Database location.","text":"This will overwrite any data at this location and all child locations.\n\nThe effect of the write will be visible immediately, and the corresponding events\n(\"value\", \"child_added\", etc.) will be triggered. Synchronization of the data to the\nFirebase servers will also be started, and the returned Promise will resolve when\ncomplete. If provided, the `onComplete` callback will be called asynchronously after\nsynchronization has finished.\n\nPassing `null` for the new value is equivalent to calling `remove();` namely, all data at\nthis location and all child locations will be deleted.\n\n`set()` will remove any priority stored at this location, so if priority is meant to be\npreserved, you need to use `setWithPriority()` instead.\n\nNote that modifying data with set() will cancel any pending transactions at that location,\nso extreme care should be taken if mixing set() and transaction() to modify the same data.\n\nA single set() will generate a single \"value\" event at the location where the set() was performed.\n\n#### Example - Setting values\n\n```js\nconst ref = firebase.database().ref('users');\n\n// Set a single node value\nawait ref.child('ada/name/first').set('Ada');\nawait ref.child('ada/name/last').set('Lovelace');\n\n// Set an object value in a single call\nawait ref.child('ada/name').set({\n  first: 'Ada',\n  last: 'Lovelace',\n});\n```\n\n#### Example - On complete listener\n\n```js\nconst ref = firebase.database().ref('users');\n\nawait ref.child('ada/first/name').set('Ada', (error) => {\n  if (error) console.error(error);\n});\n```\n"},"parameters":[{"id":997,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to be written (string, number, boolean, object, array, or null)."},"type":{"type":"intrinsic","name":"any"}},{"id":998,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Reference.set","id":901}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":212,"character":7}],"inheritedFrom":{"type":"reference","name":"Reference.set","id":901}},{"id":1006,"name":"setPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1007,"name":"setPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a priority for the data at this Database location. Setting null removes any priority at this location.","text":"See {@link database.Query#orderByPriority} to learn how to use priority values in your query.\n\n#### Example\n\n```js\nawait firebase.database().ref('users/ada').setPriority(1, (error) => {\n  if (error) console.error(error);\n});\n```\n"},"parameters":[{"id":1008,"name":"priority","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The priority value."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}},{"id":1009,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Reference.setPriority","id":912}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":270,"character":15}],"inheritedFrom":{"type":"reference","name":"Reference.setPriority","id":912}},{"id":1010,"name":"setWithPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1011,"name":"setWithPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes data the Database location. Like `set()` but also specifies the priority for that data.","text":"#### Example\n\n```js\nawait firebase.database().ref('users/ada/name')\n .setWithPriority({\n   first: 'Ada',\n   last: 'Lovelace',\n }, 1, (error) => {\n   if (error) console.error(error);\n });\n```\n"},"parameters":[{"id":1012,"name":"newVal","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new value to set."},"type":{"type":"intrinsic","name":"any"}},{"id":1013,"name":"newPriority","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new priority to set."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}},{"id":1014,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Reference.setWithPriority","id":916}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":291,"character":19}],"inheritedFrom":{"type":"reference","name":"Reference.setWithPriority","id":916}},{"id":1071,"name":"startAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1072,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a `Query` with the specified starting point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe starting point is inclusive, so children with exactly the specified value will be included\nin the query. The optional key argument can be used to further limit the range of the query.\nIf it is specified, then children that have exactly the specified value must also have a key\nname greater than or equal to the specified key.\n\nYou can read more about `startAt()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nawait firebase.database().ref('users').orderByChild('age').startAt(21).once('value');\n```\n"},"parameters":[{"id":1073,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to start at. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":1074,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to start at. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1125}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":749,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1125}},{"id":1075,"name":"toJSON","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1076,"name":"toJSON","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a JSON-serializable representation of this object."},"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","name":"Query.toJSON","id":1129}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":754,"character":10}],"inheritedFrom":{"type":"reference","name":"Query.toJSON","id":1129}},{"id":1077,"name":"toString","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1078,"name":"toString","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the absolute URL for this location.","text":"The `toString()` method returns a URL that is ready to be put into a browser, curl command, or\na `firebase.database().refFromURL()` call. Since all of those expect the URL to be url-encoded,\n`toString()` returns an encoded URL.\n\nAppend '.json' to the returned URL when typed into a browser to download JSON-formatted data.\nIf the location is secured (that is, not publicly readable), you will get a permission-denied error.\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref();\nconst ref2 = firebase.database().ref('users').orderByValue();\n\nref1.toString(); // https://sample-app.firebaseio.com/\nref2.toString(); // https://sample-app.firebaseio.com/users\n```\n"},"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"Query.toString","id":1131}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":776,"character":12}],"inheritedFrom":{"type":"reference","name":"Query.toString","id":1131}},{"id":1018,"name":"transaction","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1019,"name":"transaction","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Atomically modifies the data at this location.","text":"Atomically modify the data at this location. Unlike a normal `set()`, which just overwrites\nthe data regardless of its previous value, `transaction()` is used to modify the existing\nvalue to a new value, ensuring there are no conflicts with other clients writing to the same\nlocation at the same time.\n\nTo accomplish this, you pass `transaction()` an update function which is used to transform the\ncurrent value into a new value. If another client writes to the location before your new\nvalue is successfully written, your update function will be called again with the new\ncurrent value, and the write will be retried. This will happen repeatedly until your write\nsucceeds without conflict or you abort the transaction by not returning a value from your\nupdate function.\n\nNote: Modifying data with `set()` will cancel any pending transactions at that location, so\nextreme care should be taken if mixing `set()` and `transaction()` to update the same data.\n\nNote: When using transactions with Security and Firebase Rules in place, be aware that a\nclient needs `.read` access in addition to `.write` access in order to perform a transaction.\nThis is because the client-side nature of transactions requires the client to read the data\nin order to transactionally update it.\n\n#### Example\n\n```js\nconst userRef = firebase.database().ref('users/ada/profileViews);\n\nuserRef.transaction((currentViews) => {\n  if (currentViews === null) return 1;\n  return currentViews + 1;\n});\n```\n"},"parameters":[{"id":1020,"name":"transactionUpdate","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A developer-supplied function which will be passed the current data stored at this location (as a JavaScript object). The function should return the new value it would like written (as a JavaScript object). If undefined is returned (i.e. you return with no arguments) the transaction will be aborted and the data at this location will not be modified."},"type":{"type":"reference","name":"Function"}},{"id":1021,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback function that will be called when the transaction completes. The callback is passed three arguments: a possibly-null Error, a boolean indicating whether the transaction was committed, and a DataSnapshot indicating the final result. If the transaction failed abnormally, the first argument will be an Error object indicating the failure cause. If the transaction finished normally, but no data was committed because no data was returned from transactionUpdate, then second argument will be false. If the transaction completed and committed data to Firebase, the second argument will be true. Regardless, the third argument will be a DataSnapshot containing the resulting data in this location."},"type":{"type":"reference","name":"Function"}},{"id":1022,"name":"applyLocally","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"By default, events are raised each time the transaction update function runs. So if it is run multiple times, you may see intermediate states. You can set this to false to suppress these intermediate states and instead wait until the transaction has completed before events are raised.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"TransactionResult","id":891}]},"inheritedFrom":{"type":"reference","name":"Reference.transaction","id":924}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":358,"character":15}],"inheritedFrom":{"type":"reference","name":"Reference.transaction","id":924}},{"id":999,"name":"update","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1000,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes multiple values to the Database at once.","text":"The `values` argument contains multiple property-value pairs that will be written to the Database\ntogether. Each child property can either be a simple property (for example, \"name\") or a\nrelative path (for example, \"name/first\") from the current location to the data to update.\n\nAs opposed to the `set()` method, `update()` can be use to selectively update only the referenced\nproperties at the current location (instead of replacing all the child properties at the\ncurrent location).\n\nThe effect of the write will be visible immediately, and the corresponding events ('value',\n'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers\nwill also be started, and the returned Promise will resolve when complete. If provided, the\n`onComplete` callback will be called asynchronously after synchronization has finished.\n\nA single update() will generate a single \"value\" event at the location where the update()\nwas performed, regardless of how many children were modified.\n\nNote that modifying data with update() will cancel any pending transactions at that location,\nso extreme care should be taken if mixing update() and transaction() to modify the same data.\n\nPassing `null` to `update()` will remove the data at this location.\n\n#### Example\n\nModify the 'first' and 'last' properties, but leave other values unchanged at this location.\n\n```js\nawait firebase.database().ref('users/ada/name').update({\n  first: 'Ada',\n  last: 'Lovelace',\n})\n```\n"},"parameters":[{"id":1001,"name":"values","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Object containing multiple values."},"type":{"type":"reflection","declaration":{"id":1002,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1003,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1004,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":252,"character":18}]}}},{"id":1005,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Reference.update","id":905}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":252,"character":10}],"inheritedFrom":{"type":"reference","name":"Reference.update","id":905}}],"groups":[{"title":"Properties","kind":1024,"children":[994,989,1029,990]},{"title":"Methods","kind":2048,"children":[991,1030,1034,1038,1079,1041,1044,1047,1052,1027,1058,1062,1065,1067,1069,1023,1015,995,1006,1010,1071,1075,1077,1018,999]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":407,"character":36}],"extendedTypes":[{"type":"reference","name":"Reference","id":894}]},{"id":891,"name":"TransactionResult","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":892,"name":"committed","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":101,"character":13}],"type":{"type":"intrinsic","name":"boolean"}},{"id":893,"name":"snapshot","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":102,"character":12}],"type":{"type":"reference","name":"DataSnapshot","id":1159}}],"groups":[{"title":"Properties","kind":1024,"children":[892,893]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":100,"character":36}]},{"id":1208,"name":"EventType","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":900,"character":23}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"value"},{"type":"stringLiteral","value":"child_added"},{"type":"stringLiteral","value":"child_changed"},{"type":"stringLiteral","value":"child_moved"},{"type":"stringLiteral","value":"child_removed"}]}}],"groups":[{"title":"Classes","kind":128,"children":[1185]},{"title":"Interfaces","kind":256,"children":[1159,1136,1082,894,887,889,988,891]},{"title":"Type aliases","kind":4194304,"children":[1208]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":56,"character":38}]},{"id":1218,"name":"FirebaseDynamicLinksTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Dynamic Links package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `dynamicLinks` package:\n\n```js\nimport { firebase } from '@react-native-firebase/dynamic-links';\n\n// firebase.dynamicLinks().X\n```\n\n#### Example 2\n\nUsing the default export from the `dynamic-links` package:\n\n```js\nimport dynamicLinks from '@react-native-firebase/dynamic-links';\n\n// dynamicLinks().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/dynamic-links';\n\n// firebase.dynamicLinks().X\n```\n","tags":[{"tag":"firebase","text":"dynamic-links\n"}]},"children":[{"id":1256,"name":"ShortLinkType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"ShortLinkType determines the type of dynamic short link which Firebase creates. Used when building\na new short link via `buildShortLink()`.","text":"#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildShortLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n }, FirebaseDynamicLinksTypes.ShortLinkType.UNGUESSABLE);\n```\n"},"children":[{"id":1259,"name":"DEFAULT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"By default, Firebase returns a standard formatted link."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":393,"character":11}],"defaultValue":"\"DEFAULT\""},{"id":1257,"name":"SHORT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Shorten the path to a string that is only as long as needed to be unique, with a minimum length\nof 4 characters. Use this if sensitive information would not be exposed if a short\nDynamic Link URL were guessed."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":383,"character":9}],"defaultValue":"\"SHORT\""},{"id":1258,"name":"UNGUESSABLE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Shorten the path to an unguessable string. Such strings are created by base62-encoding randomly\ngenerated 96-bit numbers, and consist of 17 alphanumeric characters. Use unguessable strings\nto prevent your Dynamic DynamicLinks from being crawled, which can potentially expose sensitive information."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":389,"character":15}],"defaultValue":"\"UNGUESSABLE\""}],"groups":[{"title":"Enumeration members","kind":16,"children":[1259,1257,1258]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":377,"character":27}]},{"id":1265,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Dynamic DynamicLinks service is available for the default app only.","text":"#### Example 1\n\nGet the links instance for the **default app**:\n\n```js\nconst links = firebase.dynamicLinks();\n```\n"},"children":[{"id":1285,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":1266,"name":"buildLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1267,"name":"buildLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Builds a Dynamic Link from the provided DynamicLinkParameters instances.","text":"#### Example\n\n```js\nconst link = await firebase.dynamicLinks().buildLink({\n  link: 'https://invertase.io',\n  domainUriPrefix: 'https://xyz.page.link',\n  analytics: {\n    campaign: 'banner',\n  }\n});\n```\n"},"parameters":[{"id":1268,"name":"dynamicLinkParams","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object interface of DynamicLinkParameters.\n"},"type":{"type":"reference","name":"DynamicLinkParameters","id":1247}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":466,"character":13}]},{"id":1272,"name":"buildShortLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1273,"name":"buildShortLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Builds a short Dynamic Link from the provided DynamicLinkParameters interface.","text":" ```js\nconst link = await firebase.dynamicLinks().buildShortLink(\n  {\n    link: 'https://invertase.io',\n    domainUriPrefix: 'https://xyz.page.link',\n    analytics: {\n      campaign: 'banner',\n    }\n  },\n  firebase.dynamicLinks.ShortLinkType.UNGUESSABLE,\n);\n```\n"},"parameters":[{"id":1274,"name":"dynamicLinkParams","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object interface of DynamicLinkParameters."},"type":{"type":"reference","name":"DynamicLinkParameters","id":1247}},{"id":1275,"name":"shortLinkType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The short link type, one of `ShortLinkType` from `firebase.dynamicLinks.ShortLinkType`\n"},"type":{"type":"reference","name":"ShortLinkType","id":1256}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":495,"character":18}]},{"id":1269,"name":"createDynamicLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1270,"name":"createDynamicLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"**Deprecated**: Creates a link from the provided DynamicLinkParameters interface.","tags":[{"tag":"deprecated","text":"Use `buildLink` with the same args instead."}]},"parameters":[{"id":1271,"name":"dynamicLinkParams","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object interface of DynamicLinkParameters.\n"},"type":{"type":"reference","name":"DynamicLinkParameters","id":1247}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":474,"character":21}]},{"id":1276,"name":"createShortDynamicLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1277,"name":"createShortDynamicLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"**Deprecated**: Creates a short Dynamic Link from the provided DynamicLinkParameters instances.","tags":[{"tag":"deprecated","text":"Use `buildShortLink` with the same args instead."}]},"parameters":[{"id":1278,"name":"dynamicLinkParams","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object interface of DynamicLinkParameters."},"type":{"type":"reference","name":"DynamicLinkParameters","id":1247}},{"id":1279,"name":"shortLinkType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The short link type, one of `ShortLinkType` from `firebase.dynamicLinks.ShortLinkType`\n"},"type":{"type":"reference","name":"ShortLinkType","id":1256}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":507,"character":26}]},{"id":1280,"name":"getInitialLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1281,"name":"getInitialLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the Dynamic Link that the app has been launched from. If the app was not launched from a Dynamic Link the value will be null.","text":"> Use {@link auth#isSignInWithEmailLink} to check if an inbound dynamic link is an email sign-in link.\n\n#### Example\n\n```js\nasync function bootstrapApp() {\n   const initialLink = await firebase.dynamicLinks().getInitialLink();\n\n   if (initialLink) {\n     // Handle dynamic link inside your own application\n     if (initialLink.url === 'https://invertase.io/offer') return navigateTo('/offers')\n   }\n}\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"union","types":[{"type":"reference","name":"DynamicLink","id":1260},{"type":"intrinsic","name":"null"}]}]}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":530,"character":18}]},{"id":1282,"name":"onLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1283,"name":"onLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Subscribe to Dynamic Link open events while the app is still running.","text":"The listener is called from Dynamic Link open events whilst the app is still running, use\n{@link dynamic-links#getInitialLink} for Dynamic Links which cause the app to open from a previously closed / not running state.\n\n#### Example\n\n```jsx\nfunction App() {\n  const handleDynamicLink = (link) => {\n    // Handle dynamic link inside your own application\n    if (link.url === 'https://invertase.io/offer') return navigateTo('/offers')\n  };\n\n  useEffect(() => {\n    const unsubscribe = firebase.dynamicLinks().onLink(handleDynamicLink);\n    // When the component unmounts, remove the listener\n    return unsubscribe;\n  }, []);\n\n  return <YourApp />;\n}\n```\n","returns":"Unsubscribe function, call the returned function to unsubscribe from all future events."},"parameters":[{"id":1284,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The listener callback, called with Dynamic Link instances.\n"},"type":{"type":"reference","name":"Function","typeArguments":[{"type":"reference","name":"DynamicLink","id":1260}]}}],"type":{"type":"reference","name":"Function"}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":560,"character":10}]}],"groups":[{"title":"Properties","kind":1024,"children":[1285]},{"title":"Methods","kind":2048,"children":[1266,1272,1269,1276,1280,1282]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":448,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":1260,"name":"DynamicLink","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A received Dynamic Link from either `onLink` or `getInitialLink`."},"children":[{"id":1262,"name":"minimumAppVersion","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The minimum app version requested to process the dynamic link.","text":"Returns `null` if not specified.\n\n#### Android\n\nOn Android this returns a number value representing the apps [versionCode](https://developer.android.com/reference/android/content/pm/PackageInfo.html#versionCode).\n\n#### iOS\n\nOn iOS this returns a string value representing the minimum app version (not the iOS system version). If the app version of the opening app is less than the value of this property, then the app is expected to open AppStore to allow user to download most recent version. App can notify or ask the user before opening AppStore.\n\n"},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":419,"character":21}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":1261,"name":"url","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The url of the dynamic link."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":403,"character":7}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[1262,1261]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":399,"character":30}]},{"id":1219,"name":"DynamicLinkAnalyticsParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkAnalyticsParameters interface provides functionality to add Google Analytic\nbased parameters to a dynamic link.","text":"#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n   analytics: {\n     campaign: 'banner',\n     content: 'Click Me',\n   }\n });\n```\n"},"children":[{"id":1220,"name":"campaign","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The individual campaign name, slogan, promo code, etc. for a product."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":80,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1221,"name":"content","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The campaign content; used for A/B testing and content-targeted ads to differentiate ads or links that point to the same URL."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":85,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1222,"name":"medium","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The campaign medium; used to identify a medium such as email or cost-per-click (cpc)."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":90,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1223,"name":"source","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The campaign source; used to identify a search engine, newsletter, or other source."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":95,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1224,"name":"term","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The campaign term; used with paid search to supply the keywords for ads."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":100,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1220,1221,1222,1223,1224]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":76,"character":49}]},{"id":1225,"name":"DynamicLinkAndroidParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkAndroidParameters interface provides functionality to configure the behaviour\nof dynamic links for Android devices.","text":"If any parameter is declared then the Android package name must also be set via `setPackageName`\n\n#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n   android: {\n     packageName: 'io.invertase.testing',\n     minimumVersion: '18',\n   }\n });\n```\n"},"children":[{"id":1226,"name":"fallbackUrl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the link to open when the app isn't installed. Specify this to do something other than install your app from\nthe Play Store when the app isn't installed, such as open the mobile web version of the content, or display a\npromotional page for your app."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":128,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1227,"name":"minimumVersion","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the version code of the minimum version of your app that can open the link."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":133,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1228,"name":"packageName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The package name of the Android app to use to open the link. The app must be connected to your project from the Overview page of the Firebase console.","text":"This option is required if passing android options to your dynamic link.\n"},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":140,"character":15}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[1226,1227,1228]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":122,"character":47}]},{"id":1229,"name":"DynamicLinkIOSParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkIOSParameters interface provides functionality to configure the behaviour\nof dynamic links for iOS devices.","text":"If any parameter is declared then the iOS BundleId must also be set via `setBundleId`\n\n#### Example\n\n```js\nconst linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link');\nlinkParams\n  .ios.setBundleId('io.invertase.testing')\n  .ios.setAppStoreId('123456789')\n  .ios.setMinimumVersion('18');\n\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n   ios: {\n     bundleId: 'io.invertase.testing',\n     appStoreId: '123456789',\n     minimumVersion: '18',\n   }\n });\n```\n"},"children":[{"id":1230,"name":"appStoreId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the App Store ID, used to send users to the App Store when the app isn't installed."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":173,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1231,"name":"bundleId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The bundle ID of the iOS app to use to open the link. The app must be connected to your project from the Overview page of the Firebase console.","text":"This option is required if passing ios options to your dynamic link.\n"},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":180,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":1232,"name":"customScheme","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the app's custom URL scheme, if defined to be something other than your app's parameters ID."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":185,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1233,"name":"fallbackUrl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the link to open when the app isn't installed. Specify this to do something other than install your app from\nthe App Store when the app isn't installed, such as open the mobile web version of the content, or display a\npromotional page for your app."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":192,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1234,"name":"iPadBundleId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the bundle ID of the iOS app to use on iPads to open the link. The app must be connected to your project\nfrom the Overview page of the Firebase console."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":198,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1235,"name":"iPadFallbackUrl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the link to open on iPads when the app isn't installed. Specify this to do something other than install your\napp from the App Store when the app isn't installed, such as open the web version of the content, or display a\npromotional page for your app. Overrides the fallback link set by `setFallbackUrl` on iPad."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":205,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1236,"name":"minimumVersion","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the minimum version of your app that can open the link."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":210,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1230,1231,1232,1233,1234,1235,1236]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":169,"character":43}]},{"id":1237,"name":"DynamicLinkITunesParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkITunesParameters interface provides functionality to add iTunes Connect Analytics\nbased parameters to the created dynamic link.","text":"#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n   itunes: {\n     affiliateToken: 'ABCDEFG',\n   }\n });\n```\n"},"children":[{"id":1238,"name":"affiliateToken","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The affiliate token used to create affiliate-coded links."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":233,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1239,"name":"campaignToken","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The campaign token that developers can add to any link in order to track sales from a specific marketing campaign."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":238,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1240,"name":"providerToken","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The provider token that enables analytics for Dynamic DynamicLinks from within iTunes Connect."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":243,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1238,1239,1240]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":229,"character":46}]},{"id":1241,"name":"DynamicLinkNavigationParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkNavigationParameters interface provides functionality to specify how the navigation\nof the created link is handled.","text":"#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n   navigation: {\n     forcedRedirectEnabled: true,\n   }\n });\n```\n"},"children":[{"id":1242,"name":"forcedRedirectEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets whether to enable force redirecting or going to the app preview page. Defaults to false.","text":"If true, app preview page will be disabled and there will be a redirect to the FDL. If false, go to the app preview page.\n"},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":268,"character":25}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1242]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":262,"character":50}]},{"id":1247,"name":"DynamicLinkParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkParameters interface provides access to the Dynamic Link builder classes\nused to configure a created link.","text":"#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n });\n```\n"},"children":[{"id":1250,"name":"analytics","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Access Google Analytics specific link parameters."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":336,"character":13}],"type":{"type":"reference","name":"DynamicLinkAnalyticsParameters","id":1219}},{"id":1251,"name":"android","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Access Android specific link parameters."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":341,"character":11}],"type":{"type":"reference","name":"DynamicLinkAndroidParameters","id":1225}},{"id":1249,"name":"domainUriPrefix","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Domain URI Prefix of your App. This value must be your assigned domain from the Firebase console,\n(e.g. https://xyz.page.link). The domain URI prefix must start with a valid HTTPS scheme (https://)."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":331,"character":19}],"type":{"type":"intrinsic","name":"string"}},{"id":1252,"name":"ios","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Access iOS specific link parameters."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":346,"character":7}],"type":{"type":"reference","name":"DynamicLinkIOSParameters","id":1229}},{"id":1253,"name":"itunes","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Access iTunes Connect specific link parameters."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":351,"character":10}],"type":{"type":"reference","name":"DynamicLinkITunesParameters","id":1237}},{"id":1248,"name":"link","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The link the target app will open. You can specify any URL the app can handle, such as a link to the app’s content,\nor a URL that initiates some app-specific logic such as crediting the user with a coupon, or displaying a\nspecific welcome screen. This link must be a well-formatted URL, be properly URL-encoded, and use the HTTP or\nHTTPS scheme."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":325,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":1254,"name":"navigation","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Access navigation specific link parameters."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":356,"character":14}],"type":{"type":"reference","name":"DynamicLinkNavigationParameters","id":1241}},{"id":1255,"name":"social","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Access social specific link parameters."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":361,"character":10}],"type":{"type":"reference","name":"DynamicLinkSocialParameters","id":1243}}],"groups":[{"title":"Properties","kind":1024,"children":[1250,1251,1249,1252,1253,1248,1254,1255]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":318,"character":40}]},{"id":1243,"name":"DynamicLinkSocialParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkSocialParameters interface provides functionality to add additional social\nmeta-data to the URL.","text":"#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n   social: {\n     title: 'Social Application',\n     descriptionText: 'A Social Application',\n   }\n });\n```\n"},"children":[{"id":1244,"name":"descriptionText","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The description to use when the Dynamic Link is shared in a social post."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":292,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1245,"name":"imageUrl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The URL to an image related to this link."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":297,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1246,"name":"title","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The title to use when the Dynamic Link is shared in a social post."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":302,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1244,1245,1246]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":288,"character":46}]},{"id":1263,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Firebase Dynamic DynamicLinks Statics","text":"```js\nfirebase.dynamicLinks.X\n```\n"},"children":[{"id":1264,"name":"ShortLinkType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the {@link links.ShortLinkType} enum."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":433,"character":17}],"type":{"type":"reference","name":"ShortLinkType","id":1256}}],"groups":[{"title":"Properties","kind":1024,"children":[1264]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":429,"character":26}]}],"groups":[{"title":"Enumerations","kind":4,"children":[1256]},{"title":"Classes","kind":128,"children":[1265]},{"title":"Interfaces","kind":256,"children":[1260,1219,1225,1229,1237,1241,1247,1243,1263]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":56,"character":42}]},{"id":1293,"name":"FirebaseFirestoreTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Cloud Firestore package for React Native.","text":"#### Example: Access the firebase export from the `firestore` package:\n\n```js\nimport { firebase } from '@react-native-firebase/firestore';\n\n// firebase.firestore().X\n```\n\n#### Example: Using the default export from the `firestore` package:\n\n```js\nimport firestore from '@react-native-firebase/firestore';\n\n// firestore().X\n```\n\n#### Example: Using the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/firestore';\n\n// firebase.firestore().X\n```\n","tags":[{"tag":"firebase","text":"firestore\n"}]},"children":[{"id":1294,"name":"Blob","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"An immutable object representing an array of bytes."},"children":[{"id":1301,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1302,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `Blob` is equal to the provided one."},"parameters":[{"id":1303,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `Blob` to compare against.\n"},"type":{"type":"reference","name":"Blob","id":1294}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":76,"character":11}]},{"id":1304,"name":"toBase64","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1305,"name":"toBase64","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the bytes of a Blob as a Base64-encoded string."},"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":81,"character":12}]},{"id":1306,"name":"toUint8Array","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1307,"name":"toUint8Array","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the bytes of a Blob in a new Uint8Array."},"type":{"type":"reference","name":"Uint8Array"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":86,"character":16}]},{"id":1295,"name":"fromBase64String","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1296,"name":"fromBase64String","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new Blob from the given Base64 string, converting it to bytes."},"parameters":[{"id":1297,"name":"base64","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The Base64 string used to create the Blob object.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Blob","id":1294}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":62,"character":27}]},{"id":1298,"name":"fromUint8Array","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1299,"name":"fromUint8Array","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new Blob from the given Uint8Array."},"parameters":[{"id":1300,"name":"array","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The Uint8Array used to create the Blob object.\n"},"type":{"type":"reference","name":"Uint8Array"}}],"type":{"type":"reference","name":"Blob","id":1294}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":69,"character":25}]}],"groups":[{"title":"Methods","kind":2048,"children":[1301,1304,1306,1295,1298]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":56,"character":19}]},{"id":1557,"name":"FieldPath","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A FieldPath refers to a field in a document. The path may consist of a single field name (referring to a\ntop-level field in the document), or a list of field names (referring to a nested field in the document).","text":"Create a FieldPath by providing field names. If more than one field name is provided, the path will point to a nested field in a document.\n\n#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Create a new field path\nconst fieldPath = new firebase.firestore.FieldPath('address', 'zip');\n\nconsole.log('Address ZIP Code', user.get(fieldPath));\n```\n"},"children":[{"id":1560,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates a FieldPath from the provided field names. If more than one field name is provided, the path will point to a nested field in a document.","text":"#### Example\n\n```js\nconst fieldPath = new firebase.firestore.FieldPath('address', line', 'one');\n```\n"},"signatures":[{"id":1561,"name":"new FieldPath","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates a FieldPath from the provided field names. If more than one field name is provided, the path will point to a nested field in a document.","text":"#### Example\n\n```js\nconst fieldPath = new firebase.firestore.FieldPath('address', line', 'one');\n```\n"},"parameters":[{"id":1562,"name":"fieldNames","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"shortText":"A list of field names.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","name":"FieldPath","id":1557}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":590,"character":35}]},{"id":1563,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1564,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `FieldPath` is equal to the provided one.","text":"#### Example\n\n```js\nconst fieldPath1 = new firebase.firestore.FieldPath('address', 'zip');\nconst fieldPath2 = new firebase.firestore.FieldPath('address', line', 'one');\n\n// false\nfieldPath1.isEqual(fieldPath2);\n```\n"},"parameters":[{"id":1565,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `FieldPath` to compare against.\n"},"type":{"type":"reference","name":"FieldPath","id":1557}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":620,"character":11}]},{"id":1558,"name":"documentId","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1559,"name":"documentId","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a special sentinel `FieldPath` to refer to the ID of a document. It can be used in queries to sort or filter by the document ID."},"type":{"type":"reference","name":"FieldPath","id":1557}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":590,"character":21}]}],"groups":[{"title":"Constructors","kind":512,"children":[1560]},{"title":"Methods","kind":2048,"children":[1563,1558]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":586,"character":24}]},{"id":1566,"name":"FieldValue","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Sentinel values that can be used when writing document fields with `set()` or `update()`.","text":"#### Example\n\n```js\nconst increment = firebase.firestore.FieldValue.increment(1);\n\nawait firebase.firestore().doc('users/alovelace).update({\n  age: increment, // increment age by 1\n});\n```\n"},"children":[{"id":1580,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1581,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `FieldValue` is equal to the provided one.","text":"#### Example\n\n```js\nconst increment = firebase.firestore.FieldValue.increment(1);\nconst timestamp = firebase.firestore.FieldValue.serverTimestamp();\n\n// false\nincrement.isEqual(timestamp);\n```\n"},"parameters":[{"id":1582,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `FieldValue` to compare against.\n"},"type":{"type":"reference","name":"FieldValue","id":1566}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":750,"character":11}]},{"id":1567,"name":"arrayRemove","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1568,"name":"arrayRemove","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a special value that can be used with `set()` or `update()` that tells the server to remove the given elements\nfrom any array value that already exists on the server. All instances of each element specified will be removed from\nthe array. If the field being modified is not already an array it will be overwritten with an empty array.","text":"#### Example\n\n```js\nconst arrayRemove = firebase.firestore.FieldValue.arrayRemove(2, '3');\n\n// Removes the values 2 & '3' from the values array on the document\nawait docRef.update({\n  values: arrayRemove,\n});\n```\n"},"parameters":[{"id":1569,"name":"elements","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The elements to remove from the array.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"FieldValue","id":1566}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":655,"character":22}]},{"id":1570,"name":"arrayUnion","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1571,"name":"arrayUnion","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a special value that can be used with `set()` or `update()` that tells the server to union the given\nelements with any array value that already exists on the server. Each specified element that doesn't already exist\nin the array will be added to the end. If the field being modified is not already an array it will be overwritten\nwith an array containing exactly the specified elements.","text":"#### Example\n\n```js\nconst arrayUnion = firebase.firestore.FieldValue.arrayUnion(2, '3');\n\n// Appends the values 2 & '3' onto the values array on the document\nawait docRef.update({\n  values: arrayUnion,\n});\n```\n"},"parameters":[{"id":1572,"name":"elements","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The elements to union into the array.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"FieldValue","id":1566}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":676,"character":21}]},{"id":1573,"name":"delete","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1574,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a sentinel for use with update() to mark a field for deletion.","text":"#### Example\n\n```js\nconst delete = firebase.firestore.FieldValue.delete();\n\n// Deletes the name field on the document\nawait docRef.update({\n  name: delete,\n});\n```\n"},"type":{"type":"reference","name":"FieldValue","id":1566}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":692,"character":17}]},{"id":1575,"name":"increment","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1576,"name":"increment","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a special value that can be used with `set()` or `update()` that tells the server to increment the field's current value by the given value.","text":"If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics.\nIf both values are integers, values outside of JavaScript's safe number range (`Number.MIN_SAFE_INTEGER` to `Number.MAX_SAFE_INTEGER`)\nare also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are\ncapped between -2^63 and 2^63-1.\n\nIf the current field value is not of type `number`, or if the field does not yet exist, the transformation sets the field to the given value.\n\n#### Example\n\n```js\nconst increment = firebase.firestore.FieldValue.increment(1);\n\n// Increment the loginCount field by 1 on the document\nawait docRef.update({\n  loginCount: increment,\n});\n```\n"},"parameters":[{"id":1577,"name":"n","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to increment by.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"FieldValue","id":1566}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":717,"character":20}]},{"id":1578,"name":"serverTimestamp","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1579,"name":"serverTimestamp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a sentinel used with set() or update() to include a server-generated timestamp in the written data.","text":"#### Example\n\n```js\nconst timestamp = firebase.firestore.FieldValue.serverTimestamp();\n\n// Set the updatedAt field to the current server time\nawait docRef.update({\n  updatedAt: timestamp,\n});\n```\n"},"type":{"type":"reference","name":"FieldValue","id":1566}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":733,"character":26}]}],"groups":[{"title":"Methods","kind":2048,"children":[1580,1567,1570,1573,1575,1578]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":636,"character":25}]},{"id":1583,"name":"GeoPoint","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"An immutable object representing a geo point in Firestore. The geo point is represented as latitude/longitude pair.","text":"Latitude values are in the range of [-90, 90]. Longitude values are in the range of [-180, 180].\n"},"children":[{"id":1584,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates a new immutable GeoPoint object with the provided latitude and longitude values.","text":"#### Example\n\n```js\nconst geoPoint = new firebase.firestore.GeoPoint(60, -40);\n```\n"},"signatures":[{"id":1585,"name":"new GeoPoint","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates a new immutable GeoPoint object with the provided latitude and longitude values.","text":"#### Example\n\n```js\nconst geoPoint = new firebase.firestore.GeoPoint(60, -40);\n```\n"},"parameters":[{"id":1586,"name":"latitude","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The latitude as number between -90 and 90."},"type":{"type":"intrinsic","name":"number"}},{"id":1587,"name":"longitude","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The longitude as number between -180 and 180.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"GeoPoint","id":1583}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":758,"character":25}]},{"id":1588,"name":"latitude","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The latitude of this `GeoPoint` instance."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":776,"character":12}],"type":{"type":"intrinsic","name":"number"}},{"id":1589,"name":"longitude","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The longitude of this `GeoPoint` instance."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":781,"character":13}],"type":{"type":"intrinsic","name":"number"}},{"id":1590,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1591,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `GeoPoint` is equal to the provided one.","text":"#### Example\n\n```js\nconst geoPoint1 = new firebase.firestore.GeoPoint(60, -40);\nconst geoPoint2 = new firebase.firestore.GeoPoint(60, -20);\n\n// false\ngeoPoint1.isEqual(geoPoint2);\n```\n"},"parameters":[{"id":1592,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `GeoPoint` to compare against.\n"},"type":{"type":"reference","name":"GeoPoint","id":1583}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":798,"character":11}]}],"groups":[{"title":"Constructors","kind":512,"children":[1584]},{"title":"Properties","kind":1024,"children":[1588,1589]},{"title":"Methods","kind":2048,"children":[1590]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":758,"character":23}]},{"id":1818,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Cloud Firestore service is available for the default app or a given app.","text":"#### Example: Get the firestore instance for the **default app**:\n\n```js\nconst firestoreForDefaultApp = firebase.firestore();\n```\n\n#### Example: Get the firestore instance for a **secondary app**:\n\n```js\nconst otherApp = firebase.app('otherApp');\nconst firestoreForOtherApp = firebase.firestore(otherApp);\n```\n\n"},"children":[{"id":1843,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":1819,"name":"batch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1820,"name":"batch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a write batch, used for performing multiple writes as a single atomic operation.\nThe maximum number of writes allowed in a single WriteBatch is 500, but note that each usage\nof `FieldValue.serverTimestamp()`, `FieldValue.arrayUnion()`, `FieldValue.arrayRemove()`, or `FieldValue.increment()`\ninside a WriteBatch counts as an additional write.","text":"#### Example\n\n```js\nconst batch = firebase.firestore().batch();\nbatch.delete(...);\n```\n"},"type":{"type":"reference","name":"WriteBatch","id":1782}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1833,"character":9}]},{"id":1821,"name":"collection","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1822,"name":"collection","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a `CollectionReference` instance that refers to the collection at the specified path.","text":"#### Example\n\n```js\nconst collectionReference = firebase.firestore().collection('users');\n```\n"},"parameters":[{"id":1823,"name":"collectionPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A slash-separated path to a collection.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"CollectionReference","id":1308}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1846,"character":14}]},{"id":1824,"name":"collectionGroup","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1825,"name":"collectionGroup","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that includes all documents in the database that are contained\nin a collection or subcollection with the given collectionId.","text":"#### Example\n\n```js\nconst collectionGroup = firebase.firestore().collectionGroup('orders');\n```\n"},"parameters":[{"id":1826,"name":"collectionId","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Identifies the collections to query over. Every collection or subcollection with this ID as the last segment of its path will be included. Cannot contain a slash.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1860,"character":19}]},{"id":1827,"name":"disableNetwork","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1828,"name":"disableNetwork","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Disables network usage for this instance. It can be re-enabled via `enableNetwork()`. While the\nnetwork is disabled, any snapshot listeners or get() calls will return results from cache, and any\nwrite operations will be queued until the network is restored.","text":"Returns a promise that is resolved once the network has been disabled.\n\n#### Example\n\n```js\nawait firebase.firestore().disableNetwork();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1875,"character":18}]},{"id":1829,"name":"doc","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1830,"name":"doc","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a `DocumentReference` instance that refers to the document at the specified path.","text":"#### Example\n\n```js\nconst documentReference = firebase.firestore().doc('users/alovelace');\n```\n"},"parameters":[{"id":1831,"name":"documentPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A slash-separated path to a document.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"DocumentReference","id":1427}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1888,"character":7}]},{"id":1832,"name":"enableNetwork","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1833,"name":"enableNetwork","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Re-enables use of the network for this Firestore instance after a prior call to `disableNetwork()`.","text":"#### Example\n\n```js\nawait firebase.firestore().enableNetwork();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1899,"character":17}]},{"id":1834,"name":"runTransaction","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1835,"name":"runTransaction","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Executes the given `updateFunction` and then attempts to commit the changes applied within the transaction.\nIf any document read within the transaction has changed, Cloud Firestore retries the `updateFunction`.\nIf it fails to commit after 5 attempts, the transaction fails.","text":"The maximum number of writes allowed in a single transaction is 500, but note that each usage of\n`FieldValue.serverTimestamp()`, `FieldValue.arrayUnion()`, `FieldValue.arrayRemove()`, or `FieldValue.increment()`\ninside a transaction counts as an additional write.\n\n#### Example\n\n```js\nconst cityRef = firebase.firestore().doc('cities/SF');\n\nawait firebase.firestore()\n  .runTransaction(async (transaction) => {\n    const snapshot = await transaction.get(cityRef);\n    await transaction.update(cityRef, {\n      population: snapshot.data().population + 1,\n    });\n  });\n```\n"},"parameters":[{"id":1836,"name":"updateFunction","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":1837,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1838,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1839,"name":"transaction","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Transaction","id":1755}}],"type":{"type":"reference","name":"Promise"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1924,"character":34}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"any"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1924,"character":18}]},{"id":1840,"name":"settings","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1841,"name":"settings","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Specifies custom settings to be used to configure the Firestore instance. Must be set before invoking any other methods.","text":"#### Example\n\n```js\nconst settings = {\n  cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED,\n};\n\nawait firebase.firestore().settings(settings);\n```\n"},"parameters":[{"id":1842,"name":"settings","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A `Settings` object.\n"},"type":{"type":"reference","name":"Settings","id":1720}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1941,"character":12}]}],"groups":[{"title":"Properties","kind":1024,"children":[1843]},{"title":"Methods","kind":2048,"children":[1819,1821,1824,1827,1829,1832,1834,1840]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1819,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":1733,"name":"Timestamp","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and\nfractions of seconds at nanosecond resolution in UTC Epoch time.","text":"It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one.\nIt is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are \"smeared\" so that no leap second table\nis needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.\n"},"children":[{"id":1742,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates a new timestamp."},"signatures":[{"id":1743,"name":"new Timestamp","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates a new timestamp."},"parameters":[{"id":1744,"name":"seconds","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The number of seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive."},"type":{"type":"intrinsic","name":"number"}},{"id":1745,"name":"nanoseconds","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanoseconds values that count forward in time. Must be from 0 to 999,999,999 inclusive.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Timestamp","id":1733}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1449,"character":28}]},{"id":1746,"name":"nanoseconds","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The number of nanoseconds of this `Timestamp`;"},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1462,"character":15}],"type":{"type":"intrinsic","name":"number"}},{"id":1747,"name":"seconds","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The number of seconds of this `Timestamp`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1467,"character":11}],"type":{"type":"intrinsic","name":"number"}},{"id":1748,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1749,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `Timestamp` is equal to the provided one."},"parameters":[{"id":1750,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `Timestamp` to compare against.\n"},"type":{"type":"reference","name":"Timestamp","id":1733}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1474,"character":11}]},{"id":1751,"name":"toDate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1752,"name":"toDate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Convert a Timestamp to a JavaScript Date object. This conversion causes a loss of precision since Date objects\nonly support millisecond precision.","text":"Returns a JavaScript [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) with\nmillseconds precision.\n"},"type":{"type":"reference","name":"Date"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1483,"character":10}]},{"id":1753,"name":"toMillis","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1754,"name":"toMillis","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Convert a timestamp to a numeric timestamp (in milliseconds since epoch). This operation causes a loss of precision.","text":"The point in time corresponding to this timestamp, represented as the number of milliseconds since Unix epoch 1970-01-01T00:00:00Z.\n"},"type":{"type":"intrinsic","name":"number"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1490,"character":12}]},{"id":1734,"name":"fromDate","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1735,"name":"fromDate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new timestamp from the given JavaScript [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)."},"parameters":[{"id":1736,"name":"date","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The date to initialize the `Timestamp` from.\n"},"type":{"type":"reference","name":"Date"}}],"type":{"type":"reference","name":"Timestamp","id":1733}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1437,"character":19}]},{"id":1737,"name":"fromMillis","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1738,"name":"fromMillis","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new timestamp from the given number of milliseconds."},"parameters":[{"id":1739,"name":"milliseconds","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Number of milliseconds since Unix epoch 1970-01-01T00:00:00Z.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Timestamp","id":1733}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1444,"character":21}]},{"id":1740,"name":"now","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1741,"name":"now","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new timestamp with the current date, with millisecond precision."},"type":{"type":"reference","name":"Timestamp","id":1733}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1449,"character":14}]}],"groups":[{"title":"Constructors","kind":512,"children":[1742]},{"title":"Properties","kind":1024,"children":[1746,1747]},{"title":"Methods","kind":2048,"children":[1748,1751,1753,1734,1737,1740]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1431,"character":24}]},{"id":1308,"name":"CollectionReference","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `CollectionReference` object can be used for adding documents, getting document references, and querying for\ndocuments (using the methods inherited from `Query`)."},"children":[{"id":1309,"name":"id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The collection's identifier."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":97,"character":6}],"type":{"type":"intrinsic","name":"string"}},{"id":1310,"name":"parent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A reference to the containing `DocumentReference` if this is a subcollection. If this isn't a\nsubcollection, the reference is null."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":103,"character":10}],"type":{"type":"union","types":[{"type":"reference","name":"DocumentReference","id":1427},{"type":"intrinsic","name":"null"}]}},{"id":1311,"name":"path","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A string representing the path of the referenced collection (relative to the root of the database)."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":108,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":1312,"name":"add","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1313,"name":"add","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Add a new document to this collection with the specified data, assigning it a document ID automatically.","text":"#### Example\n\n```js\nconst documentRef = await firebase.firestore().collection('users').add({\n  name: 'Ada Lovelace',\n  age: 30,\n});\n```\n"},"parameters":[{"id":1314,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An Object containing the data for the new document.\n"},"type":{"type":"reflection","declaration":{"id":1315,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1316,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1317,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":124,"character":13}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"DocumentReference","id":1427}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":124,"character":7}]},{"id":1318,"name":"doc","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1319,"name":"doc","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Get a DocumentReference for the document within the collection at the specified path. If no\npath is specified, an automatically-generated unique ID will be used for the returned DocumentReference.","text":"#### Example\n\n```js\nawait firebase.firestore().collection('users').doc('alovelace').set({\n  name: 'Ada Lovelace',\n  age: 30,\n});\n```\n"},"parameters":[{"id":1320,"name":"documentPath","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A slash-separated path to a document.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"DocumentReference","id":1427}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":141,"character":7}]},{"id":1321,"name":"endAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1322,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends at the provided document (inclusive). The end\nposition is relative to the order of the query. The document must contain all of the\nfields provided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endAt(user);\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1323,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to end at.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1596}},{"id":1324,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends at the provided fields relative to the order of the query.\nThe order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is 30 or less\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endAt(30);\n```\n"},"parameters":[{"id":1325,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to end this query at, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1596}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":852,"character":9},{"fileName":"packages/firestore/lib/index.d.ts","line":870,"character":9}],"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1596}},{"id":1326,"name":"endBefore","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1327,"name":"endBefore","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends before the provided document (exclusive). The end\nposition is relative to the order of the query. The document must contain all of the fields\nprovided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to, but not including, a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endBefore(user);\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1328,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to end before.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.endBefore","id":1601}},{"id":1329,"name":"endBefore","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends before the provided fields relative to the order of\nthe query. The order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is 29 or less\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endBefore(30);\n```\n"},"parameters":[{"id":1330,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to end this query before, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.endBefore","id":1601}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":893,"character":13},{"fileName":"packages/firestore/lib/index.d.ts","line":911,"character":13}],"inheritedFrom":{"type":"reference","name":"Query.endBefore","id":1601}},{"id":1331,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1332,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Executes the query and returns the results as a QuerySnapshot.","text":"Note: By default, get() attempts to provide up-to-date data when possible by waiting for data from the server,\nbut it may return cached data or fail if you are offline and the server cannot be reached. This behavior can be\naltered via the `GetOptions` parameter.\n\n#### Example\n\n```js\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .get({\n    source: 'server',\n  });\n```\n"},"parameters":[{"id":1333,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An object to configure the get behavior.\n"},"type":{"type":"reference","name":"GetOptions","id":1593}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"QuerySnapshot","id":1697}]},"inheritedFrom":{"type":"reference","name":"Query.get","id":1606}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":933,"character":7}],"inheritedFrom":{"type":"reference","name":"Query.get","id":1606}},{"id":1334,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1335,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this Query is equal to the provided one.","text":"#### Example\n\n```js\nconst query = firebase.firestore()\n  .collection('users')\n  .orderBy('age');\n\n// false\nquery.isEqual(\n  firebase.firestore()\n    .collection('users')\n    .orderBy('name')\n);\n```\n"},"parameters":[{"id":1336,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `Query` to compare against.\n"},"type":{"type":"reference","name":"Query","id":1595}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","name":"Query.isEqual","id":1609}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":955,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.isEqual","id":1609}},{"id":1337,"name":"limit","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1338,"name":"limit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query where the results are limited to the specified number of documents.","text":"#### Example\n\n```js\n// Get 10 users in order of age\nconst querySnapshot = firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .limit(10)\n  .get();\n```\n"},"parameters":[{"id":1339,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of items to return.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.limit","id":1612}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":973,"character":9}],"inheritedFrom":{"type":"reference","name":"Query.limit","id":1612}},{"id":1340,"name":"onSnapshot","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1341,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events.","text":"> Although an `onCompletion` callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot({\n    error: (e) => console.error(e),\n    next: (querySnapshot) => {},\n  });\n\nunsubscribe();\n```\n"},"parameters":[{"id":1342,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A single object containing `next` and `error` callbacks.\n"},"type":{"type":"reflection","declaration":{"id":1343,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1344,"name":"complete","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":997,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1345,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1346,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1347,"name":"error","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":998,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1348,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1349,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1350,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1351,"name":"next","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":999,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1352,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1353,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1354,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"groups":[{"title":"Variables","kind":32,"children":[1344,1347,1351]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":996,"character":24}]}}}],"type":{"type":"reflection","declaration":{"id":1355,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1356,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1000,"character":7}]}},"inheritedFrom":{"type":"reference","name":"Query.onSnapshot","id":1615}},{"id":1357,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events with snapshot listener options.","text":"> Although an `onCompletion` callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot({\n    includeMetadataChanges: true,\n  }, {\n    error: (e) => console.error(e),\n    next: (querySnapshot) => {},\n  });\n\nunsubscribe();\n```\n"},"parameters":[{"id":1358,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options controlling the listen behavior."},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}},{"id":1359,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A single object containing `next` and `error` callbacks.\n"},"type":{"type":"reflection","declaration":{"id":1360,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1361,"name":"complete","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1029,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1362,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1363,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1364,"name":"error","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1030,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1365,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1366,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1367,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1368,"name":"next","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1031,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1369,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1370,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1371,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"groups":[{"title":"Variables","kind":32,"children":[1361,1364,1368]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1028,"character":15}]}}}],"type":{"type":"reflection","declaration":{"id":1372,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1373,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1033,"character":6}]}},"inheritedFrom":{"type":"reference","name":"Query.onSnapshot","id":1615}},{"id":1374,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events.","text":"> Although an `onCompletion` callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot(\n    (querySnapshot) => {}, // onNext\n    (error) => console.error(error), // onError\n  );\n\nunsubscribe();\n```"},"parameters":[{"id":1375,"name":"onNext","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called every time a new `QuerySnapshot` is available."},"type":{"type":"reflection","declaration":{"id":1376,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1377,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1378,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1058,"character":13}]}}},{"id":1379,"name":"onError","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback to be called if the listen fails or is cancelled. No further callbacks will occur."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1380,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1381,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1382,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1383,"name":"onCompletion","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional function which will never be called.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1384,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1385,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reflection","declaration":{"id":1386,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1387,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1061,"character":6}]}},"inheritedFrom":{"type":"reference","name":"Query.onSnapshot","id":1615}},{"id":1388,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events with snapshot listener options.","text":"NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot(\n    { includeMetadataChanges: true }, // SnapshotListenerOptions\n    (querySnapshot) => {}, // onNext\n    (error) => console.error(error), // onError\n  );\n\nunsubscribe();\n```"},"parameters":[{"id":1389,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options controlling the listen behavior."},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}},{"id":1390,"name":"onNext","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called every time a new `QuerySnapshot` is available."},"type":{"type":"reflection","declaration":{"id":1391,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1392,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1393,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1089,"character":13}]}}},{"id":1394,"name":"onError","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback to be called if the listen fails or is cancelled. No further callbacks will occur."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1395,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1396,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1397,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1398,"name":"onCompletion","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional function which will never be called.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1399,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1400,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reflection","declaration":{"id":1401,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1402,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1092,"character":6}]}},"inheritedFrom":{"type":"reference","name":"Query.onSnapshot","id":1615}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":996,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1026,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1057,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1087,"character":14}],"inheritedFrom":{"type":"reference","name":"Query.onSnapshot","id":1615}},{"id":1403,"name":"orderBy","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1404,"name":"orderBy","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.","text":"* #### Example\n\n#### Example\n\n```js\n// Get users in order of age, descending\nconst querySnapshot = firebase.firestore()\n  .collection('users')\n  .orderBy('age', 'desc')\n  .get();\n```\n"},"parameters":[{"id":1405,"name":"fieldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The field to sort by. Either a string or FieldPath instance."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1406,"name":"directionStr","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional direction to sort by (`asc` or `desc`). If not specified, order will be ascending.\n"},"type":{"type":"union","types":[{"type":"stringLiteral","value":"asc"},{"type":"stringLiteral","value":"desc"}]}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.orderBy","id":1678}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1112,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.orderBy","id":1678}},{"id":1407,"name":"startAfter","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1408,"name":"startAfter","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts after the provided document (exclusive). The start\nposition is relative to the order of the query. The document must contain all of the fields\nprovided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to, but not including, a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAfter(user)\n  .get();\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1409,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to start after.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.startAfter","id":1682}},{"id":1410,"name":"startAfter","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts after the provided fields relative to the order of\nthe query. The order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is above 30\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAfter(30)\n  .get();\n```\n"},"parameters":[{"id":1411,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to start this query after, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.startAfter","id":1682}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1136,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1155,"character":14}],"inheritedFrom":{"type":"reference","name":"Query.startAfter","id":1682}},{"id":1412,"name":"startAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1413,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts at the provided document (inclusive). The start\nposition is relative to the order of the query. The document must contain all of the\nfields provided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAt(user)\n  .get();\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1414,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to start at.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1687}},{"id":1415,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts at the provided fields relative to the order of the query.\nThe order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is 30 or above\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAt(30)\n  .get();\n```\n"},"parameters":[{"id":1416,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to start this query at, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1687}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1179,"character":11},{"fileName":"packages/firestore/lib/index.d.ts","line":1198,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1687}},{"id":1417,"name":"where","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1418,"name":"where","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query with the additional filter that documents must contain the specified field and\nthe value should satisfy the relation constraint provided.","text":"#### Example\n\n```js\n// Get all users who's age is 30 or above\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .where('age', '>=', 30);\n  .get();\n```\n"},"parameters":[{"id":1419,"name":"fieldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The path to compare."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1420,"name":"opStr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The operation string (e.g \"<\", \"<=\", \"==\", \">\", \">=\", \"array-contains\", \"array-contains-any\", \"in\")."},"type":{"type":"reference","name":"WhereFilterOp","id":1849}},{"id":1421,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The comparison value.\n"},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.where","id":1692}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1218,"character":9}],"inheritedFrom":{"type":"reference","name":"Query.where","id":1692}}],"groups":[{"title":"Properties","kind":1024,"children":[1309,1310,1311]},{"title":"Methods","kind":2048,"children":[1312,1318,1321,1326,1331,1334,1337,1340,1403,1407,1412,1417]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":93,"character":38}],"extendedTypes":[{"type":"reference","name":"Query","id":1595}]},{"id":1422,"name":"DocumentChange","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A DocumentChange represents a change to the documents matching a query. It contains the document affected and the\ntype of change that occurred."},"children":[{"id":1423,"name":"doc","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The document affected by this change."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":152,"character":7}],"type":{"type":"reference","name":"QueryDocumentSnapshot","id":1540}},{"id":1424,"name":"newIndex","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The index of the changed document in the result set immediately after this `DocumentChange`\n(i.e. supposing that all prior `DocumentChange` objects and the current `DocumentChange` object have been applied).\nIs -1 for 'removed' events."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":159,"character":12}],"type":{"type":"intrinsic","name":"number"}},{"id":1425,"name":"oldIndex","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The index of the changed document in the result set immediately prior to this `DocumentChange` (i.e.\nsupposing that all prior `DocumentChange` objects have been applied). Is -1 for 'added' events."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":165,"character":12}],"type":{"type":"intrinsic","name":"number"}},{"id":1426,"name":"type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The type of change ('added', 'modified', or 'removed')."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":170,"character":8}],"type":{"type":"reference","name":"DocumentChangeType","id":1844}}],"groups":[{"title":"Properties","kind":1024,"children":[1423,1424,1425,1426]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":148,"character":33}]},{"id":1427,"name":"DocumentReference","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `DocumentReference` refers to a document location in a Firestore database and can be used to write, read, or listen\nto the location. The document at the referenced location may or may not exist. A `DocumentReference` can also be used\nto create a `CollectionReference` to a subcollection."},"children":[{"id":1428,"name":"firestore","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Firestore instance the document is in. This is useful for performing transactions, for example."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":205,"character":13}],"type":{"type":"reference","name":"Module","id":1818}},{"id":1429,"name":"id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The document's identifier within its collection."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":210,"character":6}],"type":{"type":"intrinsic","name":"string"}},{"id":1430,"name":"parent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Collection this `DocumentReference` belongs to."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":215,"character":10}],"type":{"type":"reference","name":"CollectionReference","id":1308}},{"id":1431,"name":"path","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A string representing the path of the referenced document (relative to the root of the database)."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":220,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":1432,"name":"collection","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1433,"name":"collection","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a `CollectionReference` instance that refers to the collection at the specified path.","text":"#### Example\n\n```js\nconst collectionRef = firebase.firestore().doc('users/alovelace').collection('orders');\n```\n"},"parameters":[{"id":1434,"name":"collectionPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A slash-separated path to a collection.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"CollectionReference","id":1308}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":233,"character":14}]},{"id":1435,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1436,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deletes the document referred to by this DocumentReference.","text":"#### Example\n\n```js\nawait firebase.firestore().doc('users/alovelace').delete();\n```\n\nThe Promise is resolved once the document has been successfully deleted from the backend\n(Note that it won't resolve while you're offline).\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":247,"character":10}]},{"id":1437,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1438,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Reads the document referred to by this DocumentReference.","text":"Note: By default, get() attempts to provide up-to-date data when possible by waiting for data\nfrom the server, but it may return cached data or fail if you are offline and the server cannot\nbe reached. This behavior can be altered via the GetOptions parameter.\n\n#### Example\n\n```js\nawait firebase.firestore().doc('users/alovelace').get({\n  source: 'server',\n});\n```\n"},"parameters":[{"id":1439,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An object to configure the get behavior.\n"},"type":{"type":"reference","name":"GetOptions","id":1593}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"DocumentSnapshot","id":1523}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":266,"character":7}]},{"id":1440,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1441,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this DocumentReference is equal to the provided one.","text":"#### Example\n\n```js\nconst alovelace = firebase.firestore().doc('users/alovelace');\nconst dsmith = firebase.firestore().doc('users/dsmith');\n\n// false\nalovelace.isEqual(dsmith);\n``\n\n@param other The `DocumentReference` to compare against.\n"},"parameters":[{"id":1442,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"DocumentReference","id":1427}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":283,"character":11}]},{"id":1443,"name":"onSnapshot","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1444,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for DocumentSnapshot events.","text":"NOTE: Although an complete callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().doc('users/alovelace')\n  .onSnapshot({\n    error: (e) => console.error(e),\n    next: (documentSnapshot) => {},\n  });\n\nunsubscribe();\n```\n"},"parameters":[{"id":1445,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A single object containing `next` and `error` callbacks.\n"},"type":{"type":"reflection","declaration":{"id":1446,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1447,"name":"complete","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":307,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1448,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1449,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1450,"name":"error","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":308,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1451,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1452,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1453,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1454,"name":"next","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":309,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1455,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1456,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1457,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"groups":[{"title":"Variables","kind":32,"children":[1447,1450,1454]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":306,"character":24}]}}}],"type":{"type":"reflection","declaration":{"id":1458,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1459,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":310,"character":7}]}}},{"id":1460,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for DocumentSnapshot events with snapshot listener options.","text":"NOTE: Although an complete callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().doc('users/alovelace')\n  .onSnapshot({\n    includeMetadataChanges: true,\n  }, {\n    error: (e) => console.error(e),\n    next: (documentSnapshot) => {},\n  });\n\nunsubscribe();\n```\n"},"parameters":[{"id":1461,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options controlling the listen behavior."},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}},{"id":1462,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A single object containing `next` and `error` callbacks.\n"},"type":{"type":"reflection","declaration":{"id":1463,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1464,"name":"complete","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":339,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1465,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1466,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1467,"name":"error","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":340,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1468,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1469,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1470,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1471,"name":"next","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":341,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1472,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1473,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1474,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"groups":[{"title":"Variables","kind":32,"children":[1464,1467,1471]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":338,"character":15}]}}}],"type":{"type":"reflection","declaration":{"id":1475,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1476,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":343,"character":6}]}}},{"id":1477,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for DocumentSnapshot events.","text":"NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().doc('users/alovelace')\n  .onSnapshot(\n    (documentSnapshot) => {}, // onNext\n    (error) => console.error(error), // onError\n  );\n\nunsubscribe();\n```"},"parameters":[{"id":1478,"name":"onNext","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called every time a new `DocumentSnapshot` is available."},"type":{"type":"reflection","declaration":{"id":1479,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1480,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1481,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":368,"character":13}]}}},{"id":1482,"name":"onError","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback to be called if the listen fails or is cancelled. No further callbacks will occur."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1483,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1484,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1485,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1486,"name":"onCompletion","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional function which will never be called.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1487,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1488,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reflection","declaration":{"id":1489,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1490,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":371,"character":6}]}}},{"id":1491,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for DocumentSnapshot events with snapshot listener options.","text":"NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().doc('users/alovelace')\n  .onSnapshot(\n    { includeMetadataChanges: true }, // SnapshotListenerOptions\n    (documentSnapshot) => {}, // onNext\n    (error) => console.error(error), // onError\n  );\n\nunsubscribe();\n```"},"parameters":[{"id":1492,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options controlling the listen behavior."},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}},{"id":1493,"name":"onNext","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called every time a new `DocumentSnapshot` is available."},"type":{"type":"reflection","declaration":{"id":1494,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1495,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1496,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":399,"character":13}]}}},{"id":1497,"name":"onError","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback to be called if the listen fails or is cancelled. No further callbacks will occur."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1498,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1499,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1500,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1501,"name":"onCompletion","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional function which will never be called.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1502,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1503,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reflection","declaration":{"id":1504,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1505,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":402,"character":6}]}}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":306,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":336,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":367,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":397,"character":14}]},{"id":1506,"name":"set","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1507,"name":"set","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes to the document referred to by this DocumentReference. If the document does not yet\nexist, it will be created. If you pass SetOptions, the provided data can be merged into an\nexisting document.","text":"#### Example\n\n```js\nconst user = firebase.firestore().doc('users/alovelace');\n\n// Set new data\nawait user.set({\n  name: 'Ada Lovelace',\n  age: 30,\n  city: 'LON',\n});\n``\n\n@param data A map of the fields and values for the document.\n@param options An object to configure the set behavior.\n"},"parameters":[{"id":1508,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":1509,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1510,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1511,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":425,"character":13}]}}},{"id":1512,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"SetOptions","id":1717}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":425,"character":7}]},{"id":1513,"name":"update","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1514,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates fields in the document referred to by this `DocumentReference`. The update will fail\nif applied to a document that does not exist.","text":"#### Example\n\n```\nconst user = firebase.firestore().doc('users/alovelace');\n\n// Update age but leave other fields untouched\nawait user.update({\n  age: 31,\n});\n```\n"},"parameters":[{"id":1515,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.\n"},"type":{"type":"reflection","declaration":{"id":1516,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1517,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1518,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":444,"character":16}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}},{"id":1519,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates fields in the document referred to by this DocumentReference. The update will fail if\napplied to a document that does not exist.","text":"#### Example\n\n```\nconst user = firebase.firestore().doc('users/alovelace');\n\n// Update age & city but leve other fields untouched\nawait user.update('age', 31, 'city', 'SF');\n```\n"},"parameters":[{"id":1520,"name":"field","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The first field to update."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1521,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The first value."},"type":{"type":"intrinsic","name":"any"}},{"id":1522,"name":"moreFieldsAndValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"Additional key value pairs.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":444,"character":10},{"fileName":"packages/firestore/lib/index.d.ts","line":463,"character":10}]}],"groups":[{"title":"Properties","kind":1024,"children":[1428,1429,1430,1431]},{"title":"Methods","kind":2048,"children":[1432,1435,1437,1440,1443,1506,1513]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":201,"character":36}]},{"id":1523,"name":"DocumentSnapshot","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A DocumentSnapshot contains data read from a document in your Firestore database. The data can be extracted with\n.`data()` or `.get(:field)` to get a specific field.","text":"For a DocumentSnapshot that points to a non-existing document, any data access will return 'undefined'.\nYou can use the `exists` property to explicitly verify a document's existence.\n"},"children":[{"id":1524,"name":"exists","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Property of the `DocumentSnapshot` that signals whether or not the data exists. True if the document exists."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":477,"character":10}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1525,"name":"id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Property of the `DocumentSnapshot` that provides the document's ID."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":482,"character":6}],"type":{"type":"intrinsic","name":"string"}},{"id":1526,"name":"metadata","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Metadata about the `DocumentSnapshot`, including information about its source and local modifications."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":487,"character":12}],"type":{"type":"reference","name":"SnapshotMetadata","id":1727}},{"id":1527,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The `DocumentReference` for the document included in the `DocumentSnapshot`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":492,"character":7}],"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1528,"name":"data","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1529,"name":"data","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Retrieves all fields in the document as an Object. Returns 'undefined' if the document doesn't exist.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\nconsole.log('User', user.data());\n```\n"},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":1530,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1531,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1532,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":505,"character":11}]}},{"type":"intrinsic","name":"undefined"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":505,"character":8}]},{"id":1533,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1534,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Retrieves the field specified by fieldPath. Returns undefined if the document or field doesn't exist.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\nconsole.log('Address ZIP Code', user.get('address.zip'));\n```\n"},"typeParameter":[{"id":1535,"name":"fieldType","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","name":"DocumentFieldType","id":1845}}],"parameters":[{"id":1536,"name":"fieldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The path (e.g. 'foo' or 'foo.bar') to a specific field.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}}],"type":{"type":"typeParameter","name":"fieldType","constraint":{"type":"reference","name":"DocumentFieldType","id":1845}}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":520,"character":7}]},{"id":1537,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1538,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `DocumentSnapshot` is equal to the provided one.","text":"#### Example\n\n```js\nconst user1 = await firebase.firestore().doc('users/alovelace').get();\nconst user2 = await firebase.firestore().doc('users/dsmith').get();\n\n// false\nuser1.isEqual(user2);\n```\n"},"parameters":[{"id":1539,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `DocumentSnapshot` to compare against.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":537,"character":11}]}],"groups":[{"title":"Properties","kind":1024,"children":[1524,1525,1526,1527]},{"title":"Methods","kind":2048,"children":[1528,1533,1537]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":473,"character":35}],"extendedBy":[{"type":"reference","name":"QueryDocumentSnapshot","id":1540}]},{"id":1593,"name":"GetOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An options object that configures the behavior of get() calls on DocumentReference and Query.\nBy providing a GetOptions object, these methods can be configured to fetch results only from the\nserver, only from the local cache or attempt to fetch results from the server and fall back to the\ncache (which is the default)."},"children":[{"id":1594,"name":"source","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Describes whether we should get from server or cache.","text":"Setting to `default` (or not setting at all), causes Firestore to try to retrieve an up-to-date (server-retrieved)\nsnapshot, but fall back to returning cached data if the server can't be reached.\n\nSetting to `server` causes Firestore to avoid the cache, generating an error if the server cannot be reached. Note\nthat the cache will still be updated if the server request succeeds. Also note that latency-compensation still\ntakes effect, so any pending write operations will be visible in the returned data (merged into the server-provided data).\n\nSetting to `cache` causes Firestore to immediately return a value from the cache, ignoring the server completely\n(implying that the returned value may be stale with respect to the value on the server.) If there is no data in the\ncache to satisfy the `get()` call, `DocumentReference.get()` will return an error and `QuerySnapshot.get()` will return an\nempty `QuerySnapshot` with no documents.\n"},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":823,"character":10}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"default"},{"type":"stringLiteral","value":"server"},{"type":"stringLiteral","value":"cache"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1594]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":807,"character":29}]},{"id":1595,"name":"Query","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A Query refers to a `Query` which you can read or listen to. You can also construct refined `Query` objects by\nadding filters and ordering."},"children":[{"id":1596,"name":"endAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1597,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends at the provided document (inclusive). The end\nposition is relative to the order of the query. The document must contain all of the\nfields provided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endAt(user);\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1598,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to end at.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595}},{"id":1599,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends at the provided fields relative to the order of the query.\nThe order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is 30 or less\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endAt(30);\n```\n"},"parameters":[{"id":1600,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to end this query at, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":852,"character":9},{"fileName":"packages/firestore/lib/index.d.ts","line":870,"character":9}]},{"id":1601,"name":"endBefore","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1602,"name":"endBefore","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends before the provided document (exclusive). The end\nposition is relative to the order of the query. The document must contain all of the fields\nprovided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to, but not including, a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endBefore(user);\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1603,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to end before.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595}},{"id":1604,"name":"endBefore","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends before the provided fields relative to the order of\nthe query. The order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is 29 or less\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endBefore(30);\n```\n"},"parameters":[{"id":1605,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to end this query before, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":893,"character":13},{"fileName":"packages/firestore/lib/index.d.ts","line":911,"character":13}]},{"id":1606,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1607,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Executes the query and returns the results as a QuerySnapshot.","text":"Note: By default, get() attempts to provide up-to-date data when possible by waiting for data from the server,\nbut it may return cached data or fail if you are offline and the server cannot be reached. This behavior can be\naltered via the `GetOptions` parameter.\n\n#### Example\n\n```js\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .get({\n    source: 'server',\n  });\n```\n"},"parameters":[{"id":1608,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An object to configure the get behavior.\n"},"type":{"type":"reference","name":"GetOptions","id":1593}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"QuerySnapshot","id":1697}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":933,"character":7}]},{"id":1609,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1610,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this Query is equal to the provided one.","text":"#### Example\n\n```js\nconst query = firebase.firestore()\n  .collection('users')\n  .orderBy('age');\n\n// false\nquery.isEqual(\n  firebase.firestore()\n    .collection('users')\n    .orderBy('name')\n);\n```\n"},"parameters":[{"id":1611,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `Query` to compare against.\n"},"type":{"type":"reference","name":"Query","id":1595}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":955,"character":11}]},{"id":1612,"name":"limit","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1613,"name":"limit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query where the results are limited to the specified number of documents.","text":"#### Example\n\n```js\n// Get 10 users in order of age\nconst querySnapshot = firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .limit(10)\n  .get();\n```\n"},"parameters":[{"id":1614,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of items to return.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":973,"character":9}]},{"id":1615,"name":"onSnapshot","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1616,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events.","text":"> Although an `onCompletion` callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot({\n    error: (e) => console.error(e),\n    next: (querySnapshot) => {},\n  });\n\nunsubscribe();\n```\n"},"parameters":[{"id":1617,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A single object containing `next` and `error` callbacks.\n"},"type":{"type":"reflection","declaration":{"id":1618,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1619,"name":"complete","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":997,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1620,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1621,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1622,"name":"error","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":998,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1623,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1624,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1625,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1626,"name":"next","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":999,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1627,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1628,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1629,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"groups":[{"title":"Variables","kind":32,"children":[1619,1622,1626]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":996,"character":24}]}}}],"type":{"type":"reflection","declaration":{"id":1630,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1631,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1000,"character":7}]}}},{"id":1632,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events with snapshot listener options.","text":"> Although an `onCompletion` callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot({\n    includeMetadataChanges: true,\n  }, {\n    error: (e) => console.error(e),\n    next: (querySnapshot) => {},\n  });\n\nunsubscribe();\n```\n"},"parameters":[{"id":1633,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options controlling the listen behavior."},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}},{"id":1634,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A single object containing `next` and `error` callbacks.\n"},"type":{"type":"reflection","declaration":{"id":1635,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1636,"name":"complete","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1029,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1637,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1638,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1639,"name":"error","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1030,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1640,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1641,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1642,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1643,"name":"next","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1031,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1644,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1645,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1646,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"groups":[{"title":"Variables","kind":32,"children":[1636,1639,1643]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1028,"character":15}]}}}],"type":{"type":"reflection","declaration":{"id":1647,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1648,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1033,"character":6}]}}},{"id":1649,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events.","text":"> Although an `onCompletion` callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot(\n    (querySnapshot) => {}, // onNext\n    (error) => console.error(error), // onError\n  );\n\nunsubscribe();\n```"},"parameters":[{"id":1650,"name":"onNext","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called every time a new `QuerySnapshot` is available."},"type":{"type":"reflection","declaration":{"id":1651,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1652,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1653,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1058,"character":13}]}}},{"id":1654,"name":"onError","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback to be called if the listen fails or is cancelled. No further callbacks will occur."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1655,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1656,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1657,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1658,"name":"onCompletion","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional function which will never be called.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1659,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1660,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reflection","declaration":{"id":1661,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1662,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1061,"character":6}]}}},{"id":1663,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events with snapshot listener options.","text":"NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot(\n    { includeMetadataChanges: true }, // SnapshotListenerOptions\n    (querySnapshot) => {}, // onNext\n    (error) => console.error(error), // onError\n  );\n\nunsubscribe();\n```"},"parameters":[{"id":1664,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options controlling the listen behavior."},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}},{"id":1665,"name":"onNext","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called every time a new `QuerySnapshot` is available."},"type":{"type":"reflection","declaration":{"id":1666,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1667,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1668,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1089,"character":13}]}}},{"id":1669,"name":"onError","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback to be called if the listen fails or is cancelled. No further callbacks will occur."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1670,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1671,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1672,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1673,"name":"onCompletion","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional function which will never be called.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1674,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1675,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reflection","declaration":{"id":1676,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1677,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1092,"character":6}]}}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":996,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1026,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1057,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1087,"character":14}]},{"id":1678,"name":"orderBy","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1679,"name":"orderBy","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.","text":"* #### Example\n\n#### Example\n\n```js\n// Get users in order of age, descending\nconst querySnapshot = firebase.firestore()\n  .collection('users')\n  .orderBy('age', 'desc')\n  .get();\n```\n"},"parameters":[{"id":1680,"name":"fieldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The field to sort by. Either a string or FieldPath instance."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1681,"name":"directionStr","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional direction to sort by (`asc` or `desc`). If not specified, order will be ascending.\n"},"type":{"type":"union","types":[{"type":"stringLiteral","value":"asc"},{"type":"stringLiteral","value":"desc"}]}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1112,"character":11}]},{"id":1682,"name":"startAfter","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1683,"name":"startAfter","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts after the provided document (exclusive). The start\nposition is relative to the order of the query. The document must contain all of the fields\nprovided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to, but not including, a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAfter(user)\n  .get();\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1684,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to start after.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595}},{"id":1685,"name":"startAfter","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts after the provided fields relative to the order of\nthe query. The order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is above 30\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAfter(30)\n  .get();\n```\n"},"parameters":[{"id":1686,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to start this query after, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1136,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1155,"character":14}]},{"id":1687,"name":"startAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1688,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts at the provided document (inclusive). The start\nposition is relative to the order of the query. The document must contain all of the\nfields provided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAt(user)\n  .get();\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1689,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to start at.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595}},{"id":1690,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts at the provided fields relative to the order of the query.\nThe order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is 30 or above\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAt(30)\n  .get();\n```\n"},"parameters":[{"id":1691,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to start this query at, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1179,"character":11},{"fileName":"packages/firestore/lib/index.d.ts","line":1198,"character":11}]},{"id":1692,"name":"where","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1693,"name":"where","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query with the additional filter that documents must contain the specified field and\nthe value should satisfy the relation constraint provided.","text":"#### Example\n\n```js\n// Get all users who's age is 30 or above\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .where('age', '>=', 30);\n  .get();\n```\n"},"parameters":[{"id":1694,"name":"fieldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The path to compare."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1695,"name":"opStr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The operation string (e.g \"<\", \"<=\", \"==\", \">\", \">=\", \"array-contains\", \"array-contains-any\", \"in\")."},"type":{"type":"reference","name":"WhereFilterOp","id":1849}},{"id":1696,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The comparison value.\n"},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1218,"character":9}]}],"groups":[{"title":"Methods","kind":2048,"children":[1596,1601,1606,1609,1612,1615,1678,1682,1687,1692]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":830,"character":24}],"extendedBy":[{"type":"reference","name":"CollectionReference","id":1308}]},{"id":1540,"name":"QueryDocumentSnapshot","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A QueryDocumentSnapshot contains data read from a document in your Firestore database as part of a query.\nThe document is guaranteed to exist and its data can be extracted with .data() or .get(:field) to get a specific field.","text":"A QueryDocumentSnapshot offers the same API surface as a DocumentSnapshot.\nSince query results contain only existing documents, the exists property will always be true and data() will never return 'undefined'.\n"},"children":[{"id":1541,"name":"exists","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A QueryDocumentSnapshot is always guaranteed to exist."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":551,"character":10}],"type":{"type":"intrinsic","name":"true"},"overwrites":{"type":"reference","name":"DocumentSnapshot.exists","id":1524}},{"id":1547,"name":"id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Property of the `DocumentSnapshot` that provides the document's ID."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":482,"character":6}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.id","id":1525}},{"id":1548,"name":"metadata","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Metadata about the `DocumentSnapshot`, including information about its source and local modifications."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":487,"character":12}],"type":{"type":"reference","name":"SnapshotMetadata","id":1727},"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.metadata","id":1526}},{"id":1549,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The `DocumentReference` for the document included in the `DocumentSnapshot`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":492,"character":7}],"type":{"type":"reference","name":"DocumentReference","id":1427},"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.ref","id":1527}},{"id":1542,"name":"data","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1543,"name":"data","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Retrieves all fields in the document as an Object.","text":"#### Example\n\n```js\nconst users = await firebase.firestore().collection('users').get();\n\nfor (const user of users.docs) {\n  console.log('User', user.data());\n}\n```\n"},"type":{"type":"reflection","declaration":{"id":1544,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1545,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1546,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":566,"character":11}]}},"overwrites":{"type":"reference","name":"DocumentSnapshot.data","id":1528}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":566,"character":8}],"overwrites":{"type":"reference","name":"DocumentSnapshot.data","id":1528}},{"id":1550,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1551,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Retrieves the field specified by fieldPath. Returns undefined if the document or field doesn't exist.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\nconsole.log('Address ZIP Code', user.get('address.zip'));\n```\n"},"typeParameter":[{"id":1552,"name":"fieldType","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","name":"DocumentFieldType","id":1845}}],"parameters":[{"id":1553,"name":"fieldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The path (e.g. 'foo' or 'foo.bar') to a specific field.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}}],"type":{"type":"typeParameter","name":"fieldType","constraint":{"type":"reference","name":"DocumentFieldType","id":1845}},"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.get","id":1533}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":520,"character":7}],"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.get","id":1533}},{"id":1554,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1555,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `DocumentSnapshot` is equal to the provided one.","text":"#### Example\n\n```js\nconst user1 = await firebase.firestore().doc('users/alovelace').get();\nconst user2 = await firebase.firestore().doc('users/dsmith').get();\n\n// false\nuser1.isEqual(user2);\n```\n"},"parameters":[{"id":1556,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `DocumentSnapshot` to compare against.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.isEqual","id":1537}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":537,"character":11}],"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.isEqual","id":1537}}],"groups":[{"title":"Properties","kind":1024,"children":[1541,1547,1548,1549]},{"title":"Methods","kind":2048,"children":[1542,1550,1554]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":547,"character":40}],"extendedTypes":[{"type":"reference","name":"DocumentSnapshot","id":1523}]},{"id":1697,"name":"QuerySnapshot","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `QuerySnapshot` contains zero or more `QueryDocumentSnapshot` objects representing the results of a query. The documents\ncan be accessed as an array via the `docs` property or enumerated using the `forEach` method. The number of documents\ncan be determined via the `empty` and `size` properties."},"children":[{"id":1698,"name":"docs","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An array of all the documents in the `QuerySnapshot`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1243,"character":8}],"type":{"type":"array","elementType":{"type":"reference","name":"QueryDocumentSnapshot","id":1540}}},{"id":1699,"name":"empty","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"True if there are no documents in the `QuerySnapshot`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1248,"character":9}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1700,"name":"metadata","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Metadata about this snapshot, concerning its source and if it has local modifications."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1253,"character":12}],"type":{"type":"reference","name":"SnapshotMetadata","id":1727}},{"id":1701,"name":"query","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The query on which you called get or `onSnapshot` in order to `get` this `QuerySnapshot`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1258,"character":9}],"type":{"type":"reference","name":"Query","id":1595}},{"id":1702,"name":"size","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The number of documents in the `QuerySnapshot`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1263,"character":8}],"type":{"type":"intrinsic","name":"number"}},{"id":1703,"name":"docChanges","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1704,"name":"docChanges","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an array of the documents changes since the last snapshot. If this is the first snapshot, all documents\nwill be in the list as added changes.","text":"To include metadata changes, ensure that the `onSnapshot()` method includes metadata changes.\n\n#### Example\n\n```js\nfirebase.firestore().collection('users')\n  .onSnapshot((querySnapshot) => {\n    console.log('Metadata Changes', querySnapshot.docChanges());\n  });\n```\n\n#### Example - With metadata changes\n\n```js\nfirebase.firestore().collection('users')\n  .onSnapshot({ includeMetadataChanges: true }, (querySnapshot) => {\n    console.log('Metadata Changes', querySnapshot.docChanges({\n      includeMetadataChanges: true,\n    }));\n  });\n```\n"},"parameters":[{"id":1705,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"`SnapshotListenOptions` that control whether metadata-only changes (i.e. only `DocumentSnapshot.metadata` changed) should trigger snapshot events.\n"},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}}],"type":{"type":"array","elementType":{"type":"reference","name":"DocumentChange","id":1422}}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1293,"character":14}]},{"id":1706,"name":"forEach","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1707,"name":"forEach","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Enumerates all of the documents in the `QuerySnapshot`.","text":"#### Example\n\n```js\nconst querySnapshot = await firebase.firestore().collection('users').get();\n\nquerySnapshot.forEach((queryDocumentSnapshot) => {\n  console.log('User', queryDocumentSnapshot.data());\n})\n```\n"},"parameters":[{"id":1708,"name":"callback","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called with a `QueryDocumentSnapshot` for each document in the snapshot."},"type":{"type":"reflection","declaration":{"id":1709,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1710,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1711,"name":"result","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QueryDocumentSnapshot","id":1540}},{"id":1712,"name":"index","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1312,"character":21}]}}},{"id":1713,"name":"thisArg","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The `this` binding for the callback.\n"},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1312,"character":11}]},{"id":1714,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1715,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `QuerySnapshot` is equal to the provided one.","text":"#### Example\n\n```js\nconst querySnapshot1 = await firebase.firestore().collection('users').limit(5).get();\nconst querySnapshot2 = await firebase.firestore().collection('users').limit(10).get();\n\n// false\nquerySnapshot1.isEqual(querySnapshot2);\n```\n\n> This operation can be resource intensive when dealing with large datasets.\n"},"parameters":[{"id":1716,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `QuerySnapshot` to compare against.\n"},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1331,"character":11}]}],"groups":[{"title":"Properties","kind":1024,"children":[1698,1699,1700,1701,1702]},{"title":"Methods","kind":2048,"children":[1703,1706,1714]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1239,"character":32}]},{"id":1717,"name":"SetOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An options object that configures the behavior of set() calls in `DocumentReference`, `WriteBatch` and `Transaction`.\nThese calls can be configured to perform granular merges instead of overwriting the target documents in their entirety\nby providing a `SetOptions` with `merge: true`.","text":"Using both `merge` and `mergeFields` together will throw an error.\n"},"children":[{"id":1718,"name":"merge","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Changes the behavior of a `set()` call to only replace the values specified in its data argument.\nFields omitted from the `set()` call remain untouched."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1346,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":1719,"name":"mergeFields","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Changes the behavior of `set()` calls to only replace the specified field paths.\nAny field path that is not specified is ignored and remains untouched."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1352,"character":15}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}}}],"groups":[{"title":"Properties","kind":1024,"children":[1718,1719]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1341,"character":29}]},{"id":1720,"name":"Settings","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods.","text":"Used with `firebase.firestore().settings()`.\n"},"children":[{"id":1722,"name":"cacheSizeBytes","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An approximate cache size threshold for the on-disk data. If the cache grows beyond this size, Firestore will start\nremoving data that hasn't been recently used. The size is not a guarantee that the cache will stay below that size,\nonly that if the cache exceeds the given size, cleanup will be attempted.","text":"To disable garbage collection and set an unlimited cache size, use `firebase.firestore.CACHE_SIZE_UNLIMITED`.\n"},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1373,"character":18}],"type":{"type":"intrinsic","name":"number"}},{"id":1723,"name":"host","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The hostname to connect to."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1378,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":1721,"name":"persistence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Enables or disables local persistent storage."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1364,"character":15}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1724,"name":"ssl","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Whether to use SSL when connecting."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1383,"character":7}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[1722,1723,1721,1724]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1360,"character":27}]},{"id":1725,"name":"SnapshotListenOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An options object that can be passed to `DocumentReference.onSnapshot()`, `Query.onSnapshot()` and `QuerySnapshot.docChanges()`\nto control which types of changes to include in the result set."},"children":[{"id":1726,"name":"includeMetadataChanges","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Include a change even if only the metadata of the query or of a document changed. Default is false."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1394,"character":26}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[1726]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1390,"character":40}]},{"id":1727,"name":"SnapshotMetadata","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Metadata about a snapshot, describing the state of the snapshot."},"children":[{"id":1728,"name":"fromCache","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"True if the snapshot includes local writes (`set()` or `update()` calls) that haven't been committed to the backend yet.\nIf your listener has opted into metadata updates (via `SnapshotListenOptions`) you will receive another snapshot with\n`fromCache` equal to false once the client has received up-to-date data from the backend."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1406,"character":13}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1729,"name":"hasPendingWrites","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"True if the snapshot contains the result of local writes (e.g. `set()` or `update()` calls) that have not yet been\ncommitted to the backend. If your listener has opted into metadata updates (via `SnapshotListenOptions`) you will\nreceive another snapshot with `hasPendingWrites` equal to false once the writes have been committed to the backend."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1413,"character":20}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1730,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1731,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `SnapshotMetadata` is equal to the provided one."},"parameters":[{"id":1732,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `SnapshotMetadata` to compare against.\n"},"type":{"type":"reference","name":"SnapshotMetadata","id":1727}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1420,"character":11}]}],"groups":[{"title":"Properties","kind":1024,"children":[1728,1729]},{"title":"Methods","kind":2048,"children":[1730]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1400,"character":35}]},{"id":1808,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"`firebase.firestore.X`"},"children":[{"id":1809,"name":"Blob","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the `Blob` class."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1756,"character":8}],"type":{"type":"reference","name":"Blob","id":1294}},{"id":1814,"name":"CACHE_SIZE_UNLIMITED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Used to set the cache size to unlimited when passing to `cacheSizeBytes` in\n`firebase.firestore().settings()`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1782,"character":24}],"type":{"type":"intrinsic","name":"number"}},{"id":1810,"name":"FieldPath","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the `FieldPath` class."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1761,"character":13}],"type":{"type":"reference","name":"FieldPath","id":1557}},{"id":1811,"name":"FieldValue","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the `FieldValue` class."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1766,"character":14}],"type":{"type":"reference","name":"FieldValue","id":1566}},{"id":1812,"name":"GeoPoint","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the `GeoPoint` class."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1771,"character":12}],"type":{"type":"reference","name":"GeoPoint","id":1583}},{"id":1813,"name":"Timestamp","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the `Timestamp` class."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1776,"character":13}],"type":{"type":"reference","name":"Timestamp","id":1733}},{"id":1815,"name":"setLogLevel","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1816,"name":"setLogLevel","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the verbosity of Cloud Firestore native device logs (debug, error, or silent).","text":"- `debug`: the most verbose logging level, primarily for debugging.\n- `error`: logs only error events.\n- `silent`: turn off logging.\n\n#### Example\n\n```js\nfirebase.firestore.setLogLevel('silent');\n```\n"},"parameters":[{"id":1817,"name":"logLevel","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The verbosity you set for activity and error logging.\n"},"type":{"type":"union","types":[{"type":"stringLiteral","value":"debug"},{"type":"stringLiteral","value":"error"},{"type":"stringLiteral","value":"silent"}]}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1799,"character":15}]}],"groups":[{"title":"Properties","kind":1024,"children":[1809,1814,1810,1811,1812,1813]},{"title":"Methods","kind":2048,"children":[1815]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1752,"character":26}]},{"id":1755,"name":"Transaction","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A reference to a transaction. The `Transaction` object passed to a transaction's updateFunction provides the methods to\nread and write data within the transaction context. See `Firestore.runTransaction()`.","text":"A transaction consists of any number of `get()` operations followed by any number of write operations such as set(),\n`update()`, or `delete()`. In the case of a concurrent edit, Cloud Firestore runs the entire transaction again. For example,\nif a transaction reads documents and another client modifies any of those documents, Cloud Firestore retries the transaction.\nThis feature ensures that the transaction runs on up-to-date and consistent data.\n\nTransactions never partially apply writes. All writes execute at the end of a successful transaction.\n\nWhen using transactions, note that:\n  - Read operations must come before write operations.\n  - A function calling a transaction (transaction function) might run more than once if a concurrent edit affects a document that the transaction reads.\n  - Transaction functions should not directly modify application state (return a value from the `updateFunction`).\n  - Transactions will fail when the client is offline.\n"},"children":[{"id":1756,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1757,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deletes the document referred to by the provided `DocumentReference`.","text":"#### Example\n\n```js\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nawait firebase.firestore().runTransaction((transaction) => {\n  return transaction.delete(docRef);\n});\n```\n"},"parameters":[{"id":1758,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be deleted.\n"},"type":{"type":"reference","name":"DocumentReference","id":1427}}],"type":{"type":"reference","name":"Transaction","id":1755}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1526,"character":10}]},{"id":1759,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1760,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Reads the document referenced by the provided `DocumentReference`.","text":"#### Example\n\n```js\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nawait firebase.firestore().runTransaction(async (transaction) => {\n  const snapshot = await transaction.get(docRef);\n   // use snapshot with transaction (see set() or update())\n   ...\n});\n```\n"},"parameters":[{"id":1761,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be read.\n"},"type":{"type":"reference","name":"DocumentReference","id":1427}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"DocumentSnapshot","id":1523}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1545,"character":7}]},{"id":1762,"name":"set","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1763,"name":"set","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes to the document referred to by the provided `DocumentReference`. If the document does not exist yet,\nit will be created. If you pass `SetOptions`, the provided data can be merged into the existing document.","text":"#### Example\n\n```js\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nawait firebase.firestore().runTransaction((transaction) => {\n  const snapshot = await transaction.get(docRef);\n  const snapshotData = snapshot.data();\n\n  return transaction.set(docRef, {\n    ...data,\n    age: 30, // new field\n  });\n});\n```\n"},"parameters":[{"id":1764,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be set."},"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1765,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object of the fields and values for the document."},"type":{"type":"reflection","declaration":{"id":1766,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1767,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1768,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1573,"character":11}]}}},{"id":1769,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An object to configure the set behavior.\n"},"type":{"type":"reference","name":"SetOptions","id":1717}}],"type":{"type":"reference","name":"Transaction","id":1755}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1571,"character":7}]},{"id":1770,"name":"update","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1771,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates fields in the document referred to by the provided `DocumentReference`. The update will fail if applied\nto a document that does not exist.","text":"#### Example\n\n```js\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nawait firebase.firestore().runTransaction((transaction) => {\n  const snapshot = await transaction.get(docRef);\n\n  return transaction.update(docRef, {\n    age: snapshot.data().age + 1,\n  });\n});\n```\n"},"parameters":[{"id":1772,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be updated."},"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1773,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.\n"},"type":{"type":"reflection","declaration":{"id":1774,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1775,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1776,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1598,"character":48}]}}}],"type":{"type":"reference","name":"Transaction","id":1755}},{"id":1777,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates fields in the document referred to by the provided DocumentReference. The update will fail if applied to\na document that does not exist.","text":"Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.\n\n#### Example\n\n```js\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nawait firebase.firestore().runTransaction((transaction) => {\n  const snapshot = await transaction.get(docRef);\n\n  return transaction.update(docRef, 'age', snapshot.data().age + 1);\n});\n```\n"},"parameters":[{"id":1778,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be updated."},"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1779,"name":"field","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The first field to update."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1780,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The first value."},"type":{"type":"intrinsic","name":"any"}},{"id":1781,"name":"moreFieldsAndValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"Additional key/value pairs.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Transaction","id":1755}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1598,"character":10},{"fileName":"packages/firestore/lib/index.d.ts","line":1623,"character":10}]}],"groups":[{"title":"Methods","kind":2048,"children":[1756,1759,1762,1770]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1510,"character":30}]},{"id":1782,"name":"WriteBatch","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A write batch, used to perform multiple writes as a single atomic unit.","text":"A WriteBatch object can be acquired by calling `firestore.batch()`. It provides methods for adding\nwrites to the write batch. None of the writes will be committed (or visible locally) until\n`WriteBatch.commit()` is called.\n\nUnlike transactions, write batches are persisted offline and therefore are preferable when you don't need to\ncondition your writes on read data.\n"},"children":[{"id":1783,"name":"commit","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1784,"name":"commit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Commits all of the writes in this write batch as a single atomic unit.","text":"Returns a Promise resolved once all of the writes in the batch have been successfully written\nto the backend as an atomic unit. Note that it won't resolve while you're offline.\n\n#### Example\n\n```js\nconst batch = firebase.firestore().batch();\n\n// Perform batch operations...\n\nawait batch.commit();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1658,"character":10}]},{"id":1785,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1786,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deletes the document referred to by the provided `DocumentReference`.","text":"#### Example\n\n```js\nconst batch = firebase.firestore().batch();\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nbatch.delete(docRef);\n```\n"},"parameters":[{"id":1787,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be deleted.\n"},"type":{"type":"reference","name":"DocumentReference","id":1427}}],"type":{"type":"reference","name":"WriteBatch","id":1782}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1674,"character":10}]},{"id":1788,"name":"set","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1789,"name":"set","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes to the document referred to by the provided DocumentReference. If the document does\nnot exist yet, it will be created. If you pass SetOptions, the provided data can be merged\ninto the existing document.","text":"#### Example\n\n```js\nconst batch = firebase.firestore().batch();\nconst docRef = firebase.firestore().doc('users/dsmith');\n\nbatch.set(docRef, {\n  name: 'David Smith',\n  age: 25,\n});\n```\n"},"parameters":[{"id":1790,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be set."},"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1791,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object of the fields and values for the document."},"type":{"type":"reflection","declaration":{"id":1792,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1793,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1794,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1699,"character":11}]}}},{"id":1795,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An object to configure the set behavior.\n"},"type":{"type":"reference","name":"SetOptions","id":1717}}],"type":{"type":"reference","name":"WriteBatch","id":1782}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1697,"character":7}]},{"id":1796,"name":"update","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1797,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates fields in the document referred to by the provided DocumentReference. The update will fail if applied to a document that does not exist.","text":"#### Example\n\n```js\nconst batch = firebase.firestore().batch();\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nbatch.update(docRef, {\n  city: 'SF',\n});\n```\n"},"parameters":[{"id":1798,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be updated."},"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1799,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.\n"},"type":{"type":"reflection","declaration":{"id":1800,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1801,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1802,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1720,"character":48}]}}}],"type":{"type":"reference","name":"WriteBatch","id":1782}},{"id":1803,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates fields in the document referred to by this DocumentReference. The update will fail if applied to a document that does not exist.","text":"Nested fields can be update by providing dot-separated field path strings or by providing FieldPath objects.\n\n#### Example\n\n```js\nconst batch = firebase.firestore().batch();\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nbatch.update(docRef, 'city', 'SF', 'age', 31);\n```\n"},"parameters":[{"id":1804,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be updated."},"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1805,"name":"field","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The first field to update."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1806,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The first value."},"type":{"type":"intrinsic","name":"any"}},{"id":1807,"name":"moreFieldAndValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"Additional key value pairs.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"WriteBatch","id":1782}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1720,"character":10},{"fileName":"packages/firestore/lib/index.d.ts","line":1741,"character":10}]}],"groups":[{"title":"Methods","kind":2048,"children":[1783,1785,1788,1796]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1641,"character":29}]},{"id":1844,"name":"DocumentChangeType","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"The type of a DocumentChange may be 'added', 'removed', or 'modified'."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":176,"character":32}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"added"},{"type":"stringLiteral","value":"removed"},{"type":"stringLiteral","value":"modified"}]}},{"id":1845,"name":"DocumentFieldType","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"The types for a DocumentSnapshot field that are supported by Firestore."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":181,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"boolean"},{"type":"reflection","declaration":{"id":1846,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1847,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1848,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"DocumentFieldType","id":1845}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":185,"character":5}]}},{"type":"array","elementType":{"type":"reference","name":"DocumentFieldType","id":1845}},{"type":"intrinsic","name":"null"},{"type":"reference","name":"Timestamp","id":1733},{"type":"reference","name":"GeoPoint","id":1583},{"type":"reference","name":"Blob","id":1294},{"type":"reference","name":"FieldPath","id":1557},{"type":"reference","name":"FieldValue","id":1566},{"type":"reference","name":"DocumentReference","id":1427},{"type":"reference","name":"CollectionReference","id":1308}]}},{"id":1849,"name":"WhereFilterOp","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"Filter conditions in a `Query.where()` clause are specified using the strings '<', '<=', '==', '>=', '>', 'array-contains', 'array-contains-any' or 'in'."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1224,"character":27}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"<"},{"type":"stringLiteral","value":"<="},{"type":"stringLiteral","value":"=="},{"type":"stringLiteral","value":">"},{"type":"stringLiteral","value":">="},{"type":"stringLiteral","value":"array-contains"},{"type":"stringLiteral","value":"array-contains-any"},{"type":"stringLiteral","value":"in"}]}}],"groups":[{"title":"Classes","kind":128,"children":[1294,1557,1566,1583,1818,1733]},{"title":"Interfaces","kind":256,"children":[1308,1422,1427,1523,1593,1595,1540,1697,1717,1720,1725,1727,1808,1755,1782]},{"title":"Type aliases","kind":4194304,"children":[1844,1845,1849]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":50,"character":39}]},{"id":1857,"name":"FirebaseFunctionsTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Cloud Functions package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `functions` package:\n\n```js\nimport { firebase } from '@react-native-firebase/functions';\n\n// firebase.functions().X\n```\n\n#### Example 2\n\nUsing the default export from the `functions` package:\n\n```js\nimport functions from '@react-native-firebase/functions';\n\n// functions().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/functions';\n\n// firebase.functions().X\n```\n","tags":[{"tag":"firebase","text":"functions\n"}]},"children":[{"id":1890,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Cloud Functions service is available for the default app, a given app or a specified region.","text":"> The default functions region for all apps is `us-central1`.\n\n#### Example 1\n\nGet the functions instance for the **default app**:\n\n```js\nconst functionsForDefaultApp = firebase.functions();\n```\n\n#### Example 2\n\nGet the functions instance for a **secondary app**:\n\n```js\nconst otherApp = firebase.app('otherApp');\nconst functionsForOtherApp = firebase.functions(otherApp);\n```\n\n#### Example 3\n\nGet the functions instance for a **specific functions region**:\n\n```js\nconst defaultApp = firebase.app();\nconst functionsForRegion = defaultApp.functions('europe-west1');\n\nconst otherApp = firebase.app('otherApp');\nconst functionsForOtherAppRegion = otherApp.functions('europe-west1');\n```\n\n"},"children":[{"id":1897,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":1891,"name":"httpsCallable","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1892,"name":"httpsCallable","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets an `HttpsCallable` instance that refers to the function with the given\nname.","text":"#### Example\n\n```js\nconst instance = firebase.functions().httpsCallable('order');\n\ntry {\n const response = await instance({\n   id: '12345',\n });\n} catch (e) {\n console.error(e);\n}\n```\n","returns":"The `HttpsCallable` instance.\n"},"parameters":[{"id":1893,"name":"name","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The name of the https callable function."},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"HttpsCallable","id":1860}}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":315,"character":17}]},{"id":1894,"name":"useFunctionsEmulator","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1895,"name":"useFunctionsEmulator","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Changes this instance to point to a Cloud Functions emulator running\nlocally.","text":"See https://firebase.google.com/docs/functions/local-emulator\n\n#### Example\n\n```js\nif (__DEV__) {\n  firebase.functions().useFunctionsEmulator('http://10.0.0.8:1337');\n}\n```\n"},"parameters":[{"id":1896,"name":"origin","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The origin string of the local emulator started via firebase tools\n\"http://10.0.0.8:1337\".\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":334,"character":24}]}],"groups":[{"title":"Properties","kind":1024,"children":[1897]},{"title":"Methods","kind":2048,"children":[1891,1894]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":293,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":1860,"name":"HttpsCallable","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An HttpsCallable is a reference to a \"callable\" http trigger in\nGoogle Cloud Functions.","text":"#### Example\n\n```js\n// Create a HttpsCallable instance\nconst instance = firebase.functions().httpsCallable('order');\n\ntry {\n const response = await instance({\n   id: '12345',\n });\n} catch (e) {\n console.error(e);\n}\n```\n"},"signatures":[{"id":1861,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"An HttpsCallable is a reference to a \"callable\" http trigger in\nGoogle Cloud Functions.","text":"#### Example\n\n```js\n// Create a HttpsCallable instance\nconst instance = firebase.functions().httpsCallable('order');\n\ntry {\n const response = await instance({\n   id: '12345',\n });\n} catch (e) {\n console.error(e);\n}\n```\n"},"parameters":[{"id":1862,"name":"data","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"HttpsCallableResult","id":1858}]}}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":143,"character":32}]},{"id":1858,"name":"HttpsCallableResult","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An HttpsCallableResult wraps a single result from a function call."},"children":[{"id":1859,"name":"data","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":121,"character":17}],"type":{"type":"intrinsic","name":"any"}}],"groups":[{"title":"Properties","kind":1024,"children":[1859]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":120,"character":38}]},{"id":1863,"name":"HttpsError","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An HttpsError wraps a single error from a function call.","text":"#### Example\n\n```js\ntry {\n await firebase.functions().httpsCallable('order')();\n} catch (httpsError) {\n  console.log('Message', httpsError.message);\n\n  // Check code\n  if (httpsError.code === firebase.functions.HttpsErrorCode.NOT_FOUND) {\n    console.error('Functions endpoint \"order\" not found');\n  }\n}\n```\n"},"children":[{"id":1869,"name":"Error","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":984,"character":17}],"type":{"type":"reference","name":"ErrorConstructor"}},{"id":1864,"name":"code","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A standard error code that will be returned to the client. This also\ndetermines the HTTP status code of the response, as defined in code.proto.","text":"#### Example\n\n```js\ntry {\n await firebase.functions().httpsCallable('order')();\n} catch (httpsError) {\n  console.error(httpsError.code);\n}\n```\n"},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":180,"character":17}],"type":{"type":"reference","name":"FunctionsErrorCode","id":1898}},{"id":1865,"name":"details","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Extra data to be converted to JSON and included in the error response.","text":"```js\ntry {\n await firebase.functions().httpsCallable('order')();\n} catch (httpsError) {\n  if (httpsError.details) {\n    console.error(httpsError.details);\n  }\n}\n```\n"},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":194,"character":20}],"type":{"type":"intrinsic","name":"any"}},{"id":1867,"name":"message","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":974,"character":11}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"Error.message"}},{"id":1866,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":973,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"Error.name"}},{"id":1868,"name":"stack","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":975,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]},"overwrites":{"type":"reference","name":"Error.stack"},"inheritedFrom":{"type":"reference","name":"Error.stack"}}],"groups":[{"title":"Properties","kind":1024,"children":[1869,1864,1865,1867,1866,1868]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":165,"character":29}],"extendedTypes":[{"type":"reference","name":"Error"}]},{"id":1870,"name":"HttpsErrorCode","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The HttpsErrorCode interface provides access to all FunctionsErrorCode\ntype aliases.","text":"#### Example\n\n```js\ntry {\n await firebase.functions().httpsCallable('order')();\n} catch (httpsError) {\n switch(httpsError.code) {\n   case firebase.functions.HttpsErrorCode.NOT_FOUND:\n     console.error('Functions endpoint not found');\n     break;\n   case firebase.functions.HttpsErrorCode.CANCELLED:\n     console.error('The operation was cancelled');\n     break;\n   default:\n     console.error('An error occurred');\n     break;\n }\n}\n```\n"},"children":[{"id":1882,"name":"ABORTED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":233,"character":11}],"type":{"type":"stringLiteral","value":"aborted"}},{"id":1877,"name":"ALREADY_EXISTS","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":228,"character":18}],"type":{"type":"stringLiteral","value":"already-exists"}},{"id":1872,"name":"CANCELLED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":223,"character":13}],"type":{"type":"stringLiteral","value":"cancelled"}},{"id":1887,"name":"DATA_LOSS","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":238,"character":13}],"type":{"type":"stringLiteral","value":"data-loss"}},{"id":1875,"name":"DEADLINE_EXCEEDED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":226,"character":21}],"type":{"type":"stringLiteral","value":"deadline-exceeded"}},{"id":1881,"name":"FAILED_PRECONDITION","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":232,"character":23}],"type":{"type":"stringLiteral","value":"failed-precondition"}},{"id":1885,"name":"INTERNAL","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":236,"character":12}],"type":{"type":"stringLiteral","value":"internal"}},{"id":1874,"name":"INVALID_ARGUMENT","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":225,"character":20}],"type":{"type":"stringLiteral","value":"invalid-argument"}},{"id":1876,"name":"NOT_FOUND","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":227,"character":13}],"type":{"type":"stringLiteral","value":"not-found"}},{"id":1871,"name":"OK","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":222,"character":6}],"type":{"type":"stringLiteral","value":"ok"}},{"id":1883,"name":"OUT_OF_RANGE","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":234,"character":16}],"type":{"type":"stringLiteral","value":"out-of-range"}},{"id":1878,"name":"PERMISSION_DENIED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":229,"character":21}],"type":{"type":"stringLiteral","value":"permission-denied"}},{"id":1880,"name":"RESOURCE_EXHAUSTED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":231,"character":22}],"type":{"type":"stringLiteral","value":"resource-exhausted"}},{"id":1879,"name":"UNAUTHENTICATED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":230,"character":19}],"type":{"type":"stringLiteral","value":"unauthenticated"}},{"id":1886,"name":"UNAVAILABLE","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":237,"character":15}],"type":{"type":"stringLiteral","value":"unavailable"}},{"id":1884,"name":"UNIMPLEMENTED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":235,"character":17}],"type":{"type":"stringLiteral","value":"unimplemented"}},{"id":1873,"name":"UNKNOWN","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":224,"character":11}],"type":{"type":"stringLiteral","value":"unknown"}}],"groups":[{"title":"Properties","kind":1024,"children":[1882,1877,1872,1887,1875,1881,1885,1874,1876,1871,1883,1878,1880,1879,1886,1884,1873]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":221,"character":33}]},{"id":1888,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"firebase.functions.X"},"children":[{"id":1889,"name":"HttpsErrorCode","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Uppercase + underscored variables of {@link functions.FunctionsErrorCode}","text":"#### Example\n\n```js\nfirebase.functions.HttpsErrorCode.OK;\nfirebase.functions.HttpsErrorCode.NOT_FOUND;\n```\n"},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":255,"character":18}],"type":{"type":"reference","name":"HttpsErrorCode","id":1870}}],"groups":[{"title":"Properties","kind":1024,"children":[1889]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":244,"character":26}]},{"id":1898,"name":"FunctionsErrorCode","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":98,"character":32}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"ok"},{"type":"stringLiteral","value":"cancelled"},{"type":"stringLiteral","value":"unknown"},{"type":"stringLiteral","value":"invalid-argument"},{"type":"stringLiteral","value":"deadline-exceeded"},{"type":"stringLiteral","value":"not-found"},{"type":"stringLiteral","value":"already-exists"},{"type":"stringLiteral","value":"permission-denied"},{"type":"stringLiteral","value":"resource-exhausted"},{"type":"stringLiteral","value":"failed-precondition"},{"type":"stringLiteral","value":"aborted"},{"type":"stringLiteral","value":"out-of-range"},{"type":"stringLiteral","value":"unimplemented"},{"type":"stringLiteral","value":"internal"},{"type":"stringLiteral","value":"unavailable"},{"type":"stringLiteral","value":"data-loss"},{"type":"stringLiteral","value":"unauthenticated"}]}}],"groups":[{"title":"Classes","kind":128,"children":[1890]},{"title":"Interfaces","kind":256,"children":[1860,1858,1863,1870,1888]},{"title":"Type aliases","kind":4194304,"children":[1898]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":56,"character":39}]},{"id":1907,"name":"FirebaseIidTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Instance ID package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `iid` package:\n\n```js\nimport { firebase } from '@react-native-firebase/iid';\n\n// firebase.iid().X\n```\n\n#### Example 2\n\nUsing the default export from the `iid` package:\n\n```js\nimport iid from '@react-native-firebase/iid';\n\n// iid().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/iid';\n\n// firebase.iid().X\n```\n","tags":[{"tag":"firebase","text":"iid\n"}]},"children":[{"id":1909,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Instance ID service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Instance ID service for the default app:\n\n```js\nconst defaultAppIid = firebase.iid();\n```\n"},"children":[{"id":1922,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":1912,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1913,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Delete the Instance ID and all data associated with it. This stops the periodic sending of data to the Firebase\nbackend that was started when the Instance ID was generated.","text":"A new Instance ID is asynchronously generated unless auto initialisation is turned off.\n\n#### Example\n\n```js\nawait firebase.iid().delete();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":101,"character":10}]},{"id":1918,"name":"deleteToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1919,"name":"deleteToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Revokes access to a scope for an entity previously authorized by `getToken()`.","text":"#### Example\n\n```js\nawait firebase.iid().deleteToken(firebase.app().options.storageBucket, '*');\n```\n"},"parameters":[{"id":1920,"name":"authorizedEntity","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Entity authorized by the token. Defaults to the apps' `messagingSenderId` option."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1921,"name":"scope","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Action authorized for authorizedEntity. Defaults to '*'.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":129,"character":15}]},{"id":1910,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1911,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a identifier that uniquely identifies the app instance.","text":"Once an Instance ID is generated, Firebase periodically sends information about the application\nand the device it's running on to the Firebase backend. To stop this, see `delete()`.\n\n#### Example\n\n```js\nconst id = firebase.iid().get();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":87,"character":7}]},{"id":1914,"name":"getToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1915,"name":"getToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a token that authorizes an Entity to perform an action on behalf of the application.","text":"#### Example\n\n```js\nconst token = await firebase.iid().getToken(firebase.app().options.storageBucket, '*');\n```\n"},"parameters":[{"id":1916,"name":"authorizedEntity","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Entity authorized by the token. Defaults to the apps `messagingSenderId` option."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1917,"name":"scope","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Action authorized for authorizedEntity. Defaults to '*'.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":115,"character":12}]}],"groups":[{"title":"Properties","kind":1024,"children":[1922]},{"title":"Methods","kind":2048,"children":[1912,1918,1910,1914]}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":74,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":1908,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":59,"character":26}]}],"groups":[{"title":"Classes","kind":128,"children":[1909]},{"title":"Interfaces","kind":256,"children":[1908]}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":56,"character":33}]},{"id":1930,"name":"FirebaseInAppMessagingTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase In-App Messaging package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `inAppMessaging` package:\n\n```js\nimport { firebase } from '@react-native-firebase/in-app-messaging';\n\n// firebase.inAppMessaging().X\n```\n\n#### Example 2\n\nUsing the default export from the `in-app-messaging` package:\n\n```js\nimport inAppMessaging from '@react-native-firebase/in-app-messaging';\n\n// inAppMessaging().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/in-app-messaging';\n\n// firebase.inAppMessaging().X\n```\n","tags":[{"tag":"firebase","text":"in-app-messaging\n"}]},"children":[{"id":1932,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase In-App Messaging service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the  In-App Messaging service for the default app:\n\n```js\nconst defaultAppInAppMessaging = firebase.inAppMessaging();\n```\n"},"children":[{"id":1941,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":1937,"name":"isAutomaticDataCollectionEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Determines whether automatic data collection is enabled or not.","text":"#### Example\n\n```js\nconst isDataCollectionEnabled = firebase.inAppMessaging().isAutomaticDataCollectionEnabled;\n```\n"},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":112,"character":36}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1933,"name":"isMessagesDisplaySuppressed","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Determines whether messages are suppressed or not.","text":"#### Example\n\n```js\nconst isSuppressed = firebase.inAppMessaging().isMessagesDisplaySuppressed;\n```\n"},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":84,"character":31}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1938,"name":"setAutomaticDataCollectionEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1939,"name":"setAutomaticDataCollectionEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Enable or disable automatic data collection for Firebase In-App Messaging.","text":"When enabled, generates a registration token on app startup if there is no valid one and generates a new token\nwhen it is deleted (which prevents `deleteInstanceId()` from stopping the periodic sending of data).\n\nThis setting is persisted across app restarts and overrides the setting specified in your manifest/plist file.\n\n#### Example\n\n```js\n// Disable data collection\nfirebase.inAppMessaging().setAutomaticDataCollectionEnabled(false);\n```\n"},"parameters":[{"id":1940,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Whether automatic data collection is enabled.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":131,"character":37}]},{"id":1934,"name":"setMessagesDisplaySuppressed","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1935,"name":"setMessagesDisplaySuppressed","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Enable or disable suppression of Firebase In App Messaging messages.","text":"When enabled, no in app messages will be rendered until either you disable suppression, or the app restarts.\nThis state is not persisted between app restarts.\n\n#### Example\n\n```js\n// Suppress messages\nawait firebase.inAppMessaging().setMessagesDisplaySuppressed(true);\n```\n"},"parameters":[{"id":1936,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Whether messages should be suppressed.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":101,"character":32}]}],"groups":[{"title":"Properties","kind":1024,"children":[1941,1937,1933]},{"title":"Methods","kind":2048,"children":[1938,1934]}],"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":74,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":1931,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":59,"character":26}]}],"groups":[{"title":"Classes","kind":128,"children":[1932]},{"title":"Interfaces","kind":256,"children":[1931]}],"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":56,"character":44}]},{"id":2124,"name":"FirebaseLanguageTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase ML Kit package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `naturalLanguage` package:\n\n```js\nimport { firebase } from '@react-native-firebase/ml-natural-language';\n\n// firebase.naturalLanguage().X\n```\n\n#### Example 2\n\nUsing the default export from the `naturalLanguage` package:\n\n```js\nimport naturalLanguage from '@react-native-firebase/ml-natural-language';\n\n// naturalLanguage().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/ml-natural-language';\n\n// firebase.naturalLanguage().X\n```\n","tags":[{"tag":"firebase","text":"ml-natural-language\n"}]},"children":[{"id":2133,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase ML Kit service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the ML Kit service for the default app:\n\n```js\nconst defaultAppMLKit = firebase.naturalLanguage();\n```\n"},"children":[{"id":2145,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":2134,"name":"identifyLanguage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2135,"name":"identifyLanguage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Identifies the main language for the given text.","text":"Returns a promise that resolves with a [BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag) of the detected language.\n\nIf the language was undetected or unknown the code returned is `und`.\n\n#### Example\n\n```js\nconst language = await firebase.naturalLanguage().identifyLanguage('Hello there. General Kenobi.');\nconsole.warn(language); // en\n\nconst unknownLanguage = await firebase.naturalLanguage().identifyLanguage('foo bar baz', { confidenceThreshold: 0.9 });\nconsole.warn(language); // und\n```\n"},"parameters":[{"id":2136,"name":"text","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The input text to use for identifying the language. Inputs longer than 200 characters are truncated to 200 characters, as longer input does not improve the detection accuracy."},"type":{"type":"intrinsic","name":"string"}},{"id":2137,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"See `LanguageIdentificationOptions`.\n"},"type":{"type":"reference","name":"LanguageIdentificationOptions","id":2126}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":153,"character":20}]},{"id":2138,"name":"identifyPossibleLanguages","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2139,"name":"identifyPossibleLanguages","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Identifies possible languages for the given text.","text":"#### Example\n\n```js\nconst identifiedLanguages = firebase.naturalLanguage().identifyPossibleLanguages('hello world');\nconsole.warn(identifiedLanguages[0].language); // en\n```\n"},"parameters":[{"id":2140,"name":"text","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The input text to use for identifying the language. Inputs longer than 200 characters are truncated to 200 characters, as longer input does not improve the detection accuracy."},"type":{"type":"intrinsic","name":"string"}},{"id":2141,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"See `LanguageIdentificationOptions`.\n"},"type":{"type":"reference","name":"LanguageIdentificationOptions","id":2126}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"IdentifiedLanguage","id":2128}}]}}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":168,"character":29}]},{"id":2142,"name":"suggestReplies","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2143,"name":"suggestReplies","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns suggested replies for a conversation.","text":"#### Example\n\n```js\nconst replies = await firebase.naturalLanguage().suggestReplies([\n  { text: \"Hey, long time no speak!\", },\n  { text: 'I know right, it has been a while..', userId: 'xxxx', isLocalUser: false },\n  { text: 'We should catchup some time!', },\n  { text: 'Definitely, how about we go for lunch this week?', userId: 'xxxx', isLocalUser: false },\n]);\n```\n"},"parameters":[{"id":2144,"name":"messages","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An array of `TextMessage` interfaces.\n"},"type":{"type":"array","elementType":{"type":"reference","name":"TextMessage","id":2146}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"SuggestedReply","id":2131}}]}}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":189,"character":18}]}],"groups":[{"title":"Properties","kind":1024,"children":[2145]},{"title":"Methods","kind":2048,"children":[2134,2138,2142]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":132,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":2128,"name":"IdentifiedLanguage","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An identified language for the given input text. Returned as an Array of IdentifiedLanguage from\n`identifyPossibleLanguages`."},"children":[{"id":2130,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence score of the language. A float value between 0 and 1."},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":89,"character":14}],"type":{"type":"intrinsic","name":"number"}},{"id":2129,"name":"language","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The [BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag) for the language, e.g. 'en'."},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":84,"character":12}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2130,2129]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":80,"character":37}]},{"id":2126,"name":"LanguageIdentificationOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An interface representing the language identification options to be used with the\n`identifyLanguage` and `identifyPossibleLanguages` methods."},"children":[{"id":2127,"name":"confidenceThreshold","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The confidence threshold for language identification. The identified languages will have a\nconfidence higher or equal to the confidence threshold. The value should be between 0 and 1, e.g. 0.5.","text":"If no value is set, a default value is used instead.\n\n"},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":73,"character":23}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2127]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":65,"character":48}]},{"id":2125,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":59,"character":26}]},{"id":2131,"name":"SuggestedReply","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An interface representing a suggested reply, an array of these are returned from `suggestReplies`.","text":"#### Example\n\n```js\nconst replies = await firebase.naturalLanguage().suggestReplies([\n  { text: \"Hey, long time no speak!\", },\n  { text: 'I know right, it has been a while..', userId: 'xxxx', isLocalUser: false },\n  { text: 'We should catchup some time!', },\n  { text: 'Definitely, how about we go for lunch this week?', userId: 'xxxx', isLocalUser: false },\n]);\n\nreplies.forEach(reply => {\n  console.log(reply.text);\n});\n\n```\n\n"},"children":[{"id":2132,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The smart reply text."},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":116,"character":8}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2132]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":112,"character":33}]},{"id":2146,"name":"TextMessage","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `TextMessage` interface provided to `suggestReplies()`."},"children":[{"id":2148,"name":"isLocalUser","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Whether the message is a local user. If false, a `userId` must be provided for the message.","text":"Defaults to true.\n"},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":208,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2147,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The message text.","text":"This is required and must not be an empty string.\n"},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":201,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":2150,"name":"timestamp","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The timestamp of the message in milliseconds.","text":"Defaults to now (`Date.now()`).\n"},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":222,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":2149,"name":"userId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A user ID of a remote user.","text":"Used to help better identify users to provide more accurate replies.\n"},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":215,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2148,2147,2150,2149]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":195,"character":30}]}],"groups":[{"title":"Classes","kind":128,"children":[2133]},{"title":"Interfaces","kind":256,"children":[2128,2126,2125,2131,2146]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":56,"character":38}]},{"id":1950,"name":"FirebaseMessagingTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Messaging package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `messaging` package:\n\n```js\nimport { firebase } from '@react-native-firebase/messaging';\n\n// firebase.messaging().X\n```\n\n#### Example 2\n\nUsing the default export from the `messaging` package:\n\n```js\nimport messaging from '@react-native-firebase/messaging';\n\n// messaging().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/messaging';\n\n// firebase.messaging().X\n```\n","tags":[{"tag":"firebase","text":"messaging\n"}]},"children":[{"id":2012,"name":"AuthorizationStatus","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"An enum representing the notification authorization status for this app on the device.","text":"Value is truthy if authorized, compare against an exact status (e.g. iOS PROVISIONAL) for a more\ngranular status.\n\nExample:\n\n```js\nfirebase.messaging.AuthorizationStatus.NOT_DETERMINED;\n```\n"},"children":[{"id":2015,"name":"AUTHORIZED","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The app is authorized to create notifications."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":424,"character":14}],"defaultValue":"1"},{"id":2014,"name":"DENIED","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The app is not authorized to create notifications."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":419,"character":10}],"defaultValue":"0"},{"id":2013,"name":"NOT_DETERMINED","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The app user has not yet chosen whether to allow the application to create notifications. Usually\nthis status is returned prior to the first call of `requestPermission`.","tags":[{"tag":"platform","text":"ios iOS\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":414,"character":18}],"defaultValue":" -1"},{"id":2016,"name":"PROVISIONAL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The app is currently authorized to post non-interrupting user notifications","tags":[{"tag":"platform","text":"ios iOS >= 12\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":430,"character":15}],"defaultValue":"2"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2015,2014,2013,2016]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":407,"character":33}]},{"id":1995,"name":"NotificationAndroidPriority","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The enum representing a notification priority.","text":"Note; on devices which have channel support (Android 8.0 (API level 26) +),\nthis value will be ignored. Instead, the channel \"importance\" level is used.\n\nExample:\n\n```js\nfirebase.messaging.NotificationAndroidPriority.PRIORITY_MIN;\n```\n"},"children":[{"id":1998,"name":"PRIORITY_DEFAULT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"When a notification is received, the device smallIcon will appear in the notification shade.\nWhen the user pulls down the notification shade, the content of the notification will be shown\nin it's expanded state."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":302,"character":20}],"defaultValue":"0"},{"id":1999,"name":"PRIORITY_HIGH","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Notifications will appear on-top of applications, allowing direct interaction without pulling\nown the notification shade. This level is used for urgent notifications, such as\nincoming phone calls, messages etc, which require immediate attention."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":309,"character":17}],"defaultValue":"1"},{"id":1997,"name":"PRIORITY_LOW","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The application small icon will show in the device status bar, however the notification will\nnot alert the user (no sound or vibration). The notification will show in it's expanded state\nwhen the notification shade is pulled down."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":295,"character":16}],"defaultValue":" -1"},{"id":2000,"name":"PRIORITY_MAX","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The priority highest level a notification can be set at."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":314,"character":16}],"defaultValue":"2"},{"id":1996,"name":"PRIORITY_MIN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The application small icon will not show up in the status bar, or alert the user. The notification\nwill be in a collapsed state in the notification shade and placed at the bottom of the list."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":288,"character":16}],"defaultValue":" -2"}],"groups":[{"title":"Enumeration members","kind":16,"children":[1998,1999,1997,2000,1996]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":283,"character":41}]},{"id":2001,"name":"NotificationAndroidVisibility","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The enum representing the visibility of a notification.","text":"Example:\n\n```js\nfirebase.messaging.NotificationAndroidVisibility.VISIBILITY_SECRET;\n```\n"},"children":[{"id":2003,"name":"VISIBILITY_PRIVATE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Show this notification on all lock-screens, but conceal sensitive or private information on secure lock-screens."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":335,"character":22}],"defaultValue":"0"},{"id":2004,"name":"VISIBILITY_PUBLIC","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Show this notification in its entirety on all lock-screens."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":340,"character":21}],"defaultValue":"1"},{"id":2002,"name":"VISIBILITY_SECRET","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Do not reveal any part of this notification on a secure lock-screen."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":330,"character":21}],"defaultValue":" -1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2003,2004,2002]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":326,"character":43}]},{"id":2020,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Messaging service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Messaging service for the default app:\n\n```js\nconst defaultAppMessaging = firebase.messaging();\n```\n"},"children":[{"id":2112,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":2021,"name":"isAutoInitEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns whether messaging auto initialization is enabled or disabled for the device.","text":"#### Example\n\n```js\nconst isAutoInitEnabled = firebase.messaging().isAutoInitEnabled;\n```\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":479,"character":21}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2065,"name":"isDeviceRegisteredForRemoteMessages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a boolean value whether the user has registered for remote notifications via\n`registerDeviceForRemoteMessages()`.","text":"> You can safely access this property on Android without platform checks. Android returns `true` only.\n\n#### Example\n\n```js\nconst isRegisteredForRemoteNotifications = firebase.messaging().isRegisteredForRemoteNotifications;\n```\n","tags":[{"tag":"platform","text":"ios\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":720,"character":39}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2064,"name":"isRegisteredForRemoteNotifications","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Deprecated. See `isDeviceRegisteredForRemoteMessages` instead.","tags":[{"tag":"platform","text":"ios"},{"tag":"deprecated","text":"See isDeviceRegisteredForRemoteMessages\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":704,"character":38}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2031,"name":"deleteToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2032,"name":"deleteToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes access to an FCM token previously authorized by it's scope. Messages sent by the server\nto this token will fail.","text":"#### Example\n\n```js\nawait firebase.messaging().deleteToken();\n```\n"},"parameters":[{"id":2033,"name":"authorizedEntity","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The messaging sender ID. In most cases this will be the current default app."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2034,"name":"scope","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The scope to assign when token will be deleted.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]},"defaultValue":"\"FCM\""}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":576,"character":15}]},{"id":2070,"name":"getAPNSToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2071,"name":"getAPNSToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"On iOS, it is possible to get the users APNS token. This may be required if you want to send messages to your\niOS devices without using the FCM service.","text":"> You can safely call this method on Android without platform checks. It's a no-op on Android and will promise resolve `null`.\n\n#### Example\n\n```js\nconst apnsToken = await firebase.messaging().getAPNSToken();\n\nif (apnsToken) {\n  console.log('User APNS Token:', apnsToken);\n}\n```\n","tags":[{"tag":"ios","text":"\n"}]},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":765,"character":16}]},{"id":2025,"name":"getInitialNotification","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2026,"name":"getInitialNotification","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"When a notification from FCM has triggered the application to open from a quit state,\nthis method will return a `RemoteMessage` containing the notification data, or `null` if\nthe app was opened via another method.","text":"See `onNotificationOpenedApp` to subscribe to when the notification is opened when the app\nis in a background state.\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"union","types":[{"type":"reference","name":"RemoteMessage","id":1955},{"type":"intrinsic","name":"null"}]}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":510,"character":26}]},{"id":2027,"name":"getToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2028,"name":"getToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an FCM token for this device. Optionally you can specify a custom authorized entity\nor scope to tailor tokens to your own use-case.","text":"It is recommended you call this method on app start and update your backend with the new token.\n\nOn iOS you'll need to register for remote notifications before calling this method, you can do\nthis by calling `registerDeviceForRemoteMessages` or `requestPermission` as part of your app\nstartup. If you have not registered and you call this method you will receive an 'unregistered'\nerror code.\n\n#### Example - Default token\n\n```js\nawait firebase.messaging().registerDeviceForRemoteMessages();\nconst fcmToken = await firebase.messaging().getToken();\n\n// Update backend (e.g. Firestore) with our scoped token for the user\nconst uid = firebase.auth().currentUser.uid;\nawait firebase.firestore().doc(`users/${uid}`)\n  .update({\n    fcmTokens: firebase.firestore.FieldValues.arrayUnion(fcmToken),\n  });\n```\n\n#### Example - Scoped Token\n\nThe below example creates a new token for a specific notification scope (in this case, ALARM).\nYour server can specifically send messages to 'ALARM' tokens. By default, all notification scopes\nwill be received.\n\n```js\n// Get a token for 'ALARM' notifications\nconst alarmFcmToken = await firebase.messaging().getToken(\n  firebase.app().options.messagingSenderId, // default to this app\n  'ALARM', // defaults to 'FCM'\n);\n\n// Update backend (e.g. Firestore) with our scoped token for the user\nconst uid = firebase.auth().currentUser.uid;\nawait firebase.firestore().doc(`users/${uid}`)\n  .update({\n    alarmFcmTokens: firebase.firestore.FieldValues.arrayUnion(alarmFcmToken),\n  });\n```\n"},"parameters":[{"id":2029,"name":"authorizedEntity","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The messaging sender ID. In most cases this will be the current default app."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2030,"name":"scope","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The scope to assign a token, which the sever can use to target messages at.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]},"defaultValue":"\"FCM\""}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":561,"character":12}]},{"id":2072,"name":"hasPermission","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2073,"name":"hasPermission","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a `AuthorizationStatus` as to whether the user has messaging permission for this app.","text":"#### Example\n\n```js\nconst authStatus = await firebase.messaging().hasPermission();\nif (authStatus === firebase.messaging.AuthorizationStatus.AUTHORIZED) {\n  // yay\n}\n\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"AuthorizationStatus","id":2012}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":780,"character":17}]},{"id":2074,"name":"onDeletedMessages","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2075,"name":"onDeletedMessages","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Called when the FCM server deletes pending messages. This may be due to:","text":"1. Too many messages stored on the FCM server. This can occur when an app's servers send a bunch\nof non-collapsible messages to FCM servers while the device is offline.\n\n2. The device hasn't connected in a long time and the app server has recently (within the last\n4 weeks) sent a message to the app on that device.\n\nIt is recommended that the app do a full sync with the server after receiving this call (e.g.\nrequesting all user messages from the database).\n\nReturns an unsubscribe function to stop listening for deleted messages.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.messaging().onDeletedMessages(() => {\n  // Perform a full app re-sync\n});\n\n// Unsubscribe from deleted messages events\nunsubscribe();\n```\n"},"parameters":[{"id":2076,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Called when the FCM deletes pending messages.\n"},"type":{"type":"reflection","declaration":{"id":2077,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2078,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":809,"character":31}]}}}],"type":{"type":"reflection","declaration":{"id":2079,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2080,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":809,"character":44}]}}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":809,"character":21}]},{"id":2035,"name":"onMessage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2036,"name":"onMessage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"When any FCM payload is received, the listener callback is called with a `RemoteMessage`.","text":"Returns an unsubscribe function to stop listening for new messages.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.messaging().onMessage(async (remoteMessage) => {\n  console.log('FCM Message Data:', remoteMessage.data);\n\n   // Update a users messages list using AsyncStorage\n   const currentMessages = await AsyncStorage.getItem('messages');\n   const messageArray = JSON.parse(currentMessages);\n   messageArray.push(remoteMessage.data);\n   await AsyncStorage.setItem('messages', JSON.stringify(messageArray));\n});\n\n// Unsubscribe from further message events\nunsubscribe();\n```\n\n> This subscriber method is only called when the app is active (in the foreground).\n"},"parameters":[{"id":2037,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Called with a `RemoteMessage` when a new FCM payload is received from the server.\n"},"type":{"type":"reflection","declaration":{"id":2038,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2039,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2040,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"RemoteMessage","id":1955}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":604,"character":23}]}}}],"type":{"type":"reflection","declaration":{"id":2041,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2042,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":604,"character":57}]}}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":604,"character":13}]},{"id":2081,"name":"onMessageSent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2082,"name":"onMessageSent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"When sending a `RemoteMessage`, this listener is called when the message has been sent to FCM.","text":"Returns an unsubscribe function to stop listening for sent messages.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.messaging().onMessageSent((messageId) => {\n  console.log('Message has been sent to the FCM server', messageId);\n});\n\n// Unsubscribe from message sent events\nunsubscribe();\n```\n"},"parameters":[{"id":2083,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Called when the FCM sends the remote message to FCM.\n"},"type":{"type":"reflection","declaration":{"id":2084,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2085,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2086,"name":"messageId","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":829,"character":27}]}}}],"type":{"type":"reflection","declaration":{"id":2087,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2088,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":829,"character":56}]}}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":829,"character":17}]},{"id":2043,"name":"onNotificationOpenedApp","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2044,"name":"onNotificationOpenedApp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"When the user presses a notification displayed via FCM, this listener will be called if the app\nhas opened from a background state.","text":"See `getInitialNotification` to see how to watch for when a notification opens the app from a\nquit state.\n"},"parameters":[{"id":2045,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Called with a `RemoteMessage` when a notification press opens the application.\n"},"type":{"type":"reflection","declaration":{"id":2046,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2047,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2048,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"RemoteMessage","id":1955}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":615,"character":37}]}}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":615,"character":27}]},{"id":2089,"name":"onSendError","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2090,"name":"onSendError","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"When sending a `RemoteMessage`, this listener is called when an error is thrown and the\nmessage could not be sent.","text":"Returns an unsubscribe function to stop listening for sent errors.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.messaging().onSendError(({ messageId, error }) => {\n  console.log('An error occurred when sending a message to FCM', messageId, error);\n});\n\n// Unsubscribe from message sent error events\nunsubscribe();\n```\n"},"parameters":[{"id":2091,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"\n"},"type":{"type":"reflection","declaration":{"id":2092,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2093,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2094,"name":"evt","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"SendErrorEvent","id":2017}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":850,"character":25}]}}}],"type":{"type":"reflection","declaration":{"id":2095,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2096,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":850,"character":56}]}}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":850,"character":15}]},{"id":2049,"name":"onTokenRefresh","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2050,"name":"onTokenRefresh","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Called when a new registration token is generated for the device. For example, this event can happen when a\ntoken expires or when the server invalidates the token.","text":"Your app should always subscribe to this event and update your backend to ensure your device will\nreceive new messages. The listener is only called when the app is active (in foreground), so ensure\nyou call `getToken()` on app open to handle any new tokens generated when the app was not active.\n\nReturns an unsubscribe function to stop listening for token refresh events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.messaging().onTokenRefresh(async (fcmToken) => {\n  console.log('New FCM Token:', fcmToken);\n\n  // Append the database with the users new FCM token (e.g. with Firestore)\n  const uid = firebase.auth().currentUser.uid;\n  await firebase.firestore().doc(`users/${uid}`)\n    .update({\n      fcmTokens: firebase.firestore.FieldValues.arrayUnion(fcmToken),\n    });\n});\n```\n\n> This subscriber method is only called when the app is active (in the foreground).\n"},"parameters":[{"id":2051,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Called with a FCM token when the token is refreshed.\n"},"type":{"type":"reflection","declaration":{"id":2052,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2053,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2054,"name":"token","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":646,"character":28}]}}}],"type":{"type":"reflection","declaration":{"id":2055,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2056,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":646,"character":53}]}}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":646,"character":18}]},{"id":2062,"name":"registerDeviceForRemoteMessages","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2063,"name":"registerDeviceForRemoteMessages","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"On iOS, if your app wants to receive remote messages from FCM (via APNS), you must explicitly register\nthis request with APNS. For example if you want to display alerts, play sounds\nor perform other user-facing actions (via the Notification library), you must call this method.","text":"> You can safely call this method on Android without platform checks. It's a no-op on Android and will promise resolve `void`.\n\n> You can safely call this method multiple times, if the app is already registered then this method resolves immediately.\n\n#### Example\n\n```js\nif (!firebase.messaging().isDeviceRegisteredForRemoteMessages) {\n  await firebase.messaging().registerDeviceForRemoteMessages();\n}\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":696,"character":35}]},{"id":2060,"name":"registerForRemoteNotifications","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2061,"name":"registerForRemoteNotifications","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deprecated. See `registerDeviceForRemoteMessages` instead.","tags":[{"tag":"platform","text":"ios"},{"tag":"deprecated","text":"See registerDeviceForRemoteMessages.\n"}]},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":677,"character":34}]},{"id":2057,"name":"requestPermission","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2058,"name":"requestPermission","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"On iOS, messaging permission must be requested by the current application before messages can\nbe received or sent.","text":"On iOS < 12, a modal will be shown to the user requesting messaging permissions for the app.\nOnce handled, the promise will resolve with `true` if permission was granted.\n\nOn iOS >= 12, the app will be granted [Provisional Authorization](http://iosbrain.com/blog/2018/07/05/new-in-ios-12-implementing-provisional-authorization-for-quiet-notifications-in-swift/),\nand will resolve `true`. The user will be able to receive FCM payloads and Notifications immediately;\nbut notifications will be displayed silently. The user, through Notification Center, then has the option of upgrading your apps notifications to no longer be silent.\n\n> You can safely call this method on Android without platform checks. It's a no-op on Android and will promise resolve `true`.\n\n#### Example\n\n```js\nconst permissionGranted = await firebase.messaging().requestPermission();\n```\n","tags":[{"tag":"ios","text":"\n"}]},"parameters":[{"id":2059,"name":"permissions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"IOSPermissions","id":2005}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"AuthorizationStatus","id":2012}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":669,"character":21}]},{"id":2103,"name":"sendMessage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2104,"name":"sendMessage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Send a new `RemoteMessage` to the FCM server.","text":"The promise resolves when the message has been added to the internal queue. Use `onMessageSent()`\nand `onSendError()` to determine when the message has been sent to the server.\n\n#### Example\n\n```js\nawait firebase.messaging().sendMessage({\n  data: {\n    loggedIn: Date.now(),\n    uid: firebase.auth().currentUser.uid,\n  }\n});\n```\n"},"parameters":[{"id":2105,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A `RemoteMessage` interface.\n"},"type":{"type":"reference","name":"RemoteMessage","id":1955}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":897,"character":15}]},{"id":2022,"name":"setAutoInitEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2023,"name":"setAutoInitEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets whether auto initialization for messaging is enabled or disabled.","text":"Set this to false to allow for an 'opt-in-first' flow for your users. By default auto\ninitialization is enabled, which updates the device identifier and configuration data needed\nfor messaging to Firebase.\n\nTo ensure first app opens have an initial value set, set the argument in the `firebase.json`\nconfig.\n\n#### Example\n\n```js\n// Disable auto initialization\nawait firebase.messaging().setAutoInitEnabled(false);\n```\n"},"parameters":[{"id":2024,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A boolean value to enable or disable auto initialization.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":500,"character":22}]},{"id":2097,"name":"setBackgroundMessageHandler","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2098,"name":"setBackgroundMessageHandler","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"On Android, set a message handler function which is called when the app is in the background\nor terminated. A headless task is created, allowing you to access the React Native environment\nto perform tasks such as updating local storage, or sending a network request.","text":"This method must be called **outside** of your application lifecycle, e.g. alongside your\n`AppRegistry.registerComponent()` method call at the the entry point of your application code.\n\n> You can safely call this method on iOS without platform checks. It's a no-op on iOS.\n\n#### Example\n\n```js\nfirebase.messaging().setBackgroundMessageHandler(async (remoteMessage) => {\n   // Update a users messages list using AsyncStorage\n   const currentMessages = await AsyncStorage.getItem('messages');\n   const messageArray = JSON.parse(currentMessages);\n   messageArray.push(remoteMessage.data);\n   await AsyncStorage.setItem('messages', JSON.stringify(messageArray));\n});\n```\n","tags":[{"tag":"android","text":"\n"}]},"parameters":[{"id":2099,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":2100,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2101,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2102,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"RemoteMessage","id":1955}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"any"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":876,"character":40}]}}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":876,"character":31}]},{"id":2106,"name":"subscribeToTopic","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2107,"name":"subscribeToTopic","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Apps can subscribe to a topic, which allows the FCM server to send targeted messages to only those\ndevices subscribed to that topic.","text":"#### Example\n\n```js\nawait firebase.messaging().subscribeToTopic('news');\n```\n"},"parameters":[{"id":2108,"name":"topic","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The topic name.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":911,"character":20}]},{"id":2068,"name":"unregisterDeviceForRemoteMessages","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2069,"name":"unregisterDeviceForRemoteMessages","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unregisters the app from receiving remote notifications.","text":"> You can safely call this method on Android without platform checks. It's a no-op on Android and will promise resolve `void`.\n\n#### Example\n\n```js\nif (firebase.messaging().isDeviceRegisteredForRemoteMessages) {\n  await firebase.messaging().unregisterDeviceForRemoteMessages();\n}\n```\n","tags":[{"tag":"platform","text":"ios\n"}]},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":745,"character":37}]},{"id":2066,"name":"unregisterForRemoteNotifications","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2067,"name":"unregisterForRemoteNotifications","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deprecated. See `unregisterDeviceForRemoteMessages` instead.","tags":[{"tag":"platform","text":"ios"},{"tag":"deprecated","text":"See unregisterDeviceForRemoteMessages.\n"}]},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":728,"character":36}]},{"id":2109,"name":"unsubscribeFromTopic","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2110,"name":"unsubscribeFromTopic","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unsubscribe the device from a topic.","text":"#### Example\n\n```js\nawait firebase.messaging().unsubscribeFromTopic('news');\n```\n"},"parameters":[{"id":2111,"name":"topic","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The topic name.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":924,"character":24}]}],"groups":[{"title":"Properties","kind":1024,"children":[2112,2021,2065,2064]},{"title":"Methods","kind":2048,"children":[2031,2070,2025,2027,2072,2074,2035,2081,2043,2089,2049,2062,2060,2057,2103,2022,2097,2106,2068,2066,2109]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":469,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":2005,"name":"IOSPermissions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An interface representing all the available permissions that can be requested by your app via\nthe `requestPermission` API."},"children":[{"id":2006,"name":"alert","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Request permission to display alerts.","text":"Defaults to true.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":353,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2007,"name":"announcement","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Request permission for Siri to automatically read out notification messages over AirPods.","text":"Defaults to false.\n","tags":[{"tag":"platform","text":"ios iOS >= 13\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":362,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2008,"name":"badge","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Request permission to update the application badge.","text":"Defaults to true.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":369,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2009,"name":"carPlay","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Request permission to display notifications in a CarPlay environment.","text":"Defaults to true.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":376,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2010,"name":"provisional","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Request permission to provisionally create non-interrupting notifications.","text":"Defaults to false.\n","tags":[{"tag":"platform","text":"ios iOS >= 12\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":385,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2011,"name":"sound","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Request permission to play sounds.","text":"Defaults to true.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":392,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2006,2007,2008,2009,2010,2011]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":347,"character":33}]},{"id":1970,"name":"Notification","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":1978,"name":"android","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Additional Android specific properties set on the notification."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":171,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1979,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1981,"name":"channelId","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The channel ID set on the notification. If not set, the notification uses the default\n\"Miscellaneous\" channel set by FCM."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":183,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1987,"name":"clickAction","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"Name of the click action set on the notification."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":214,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1982,"name":"color","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The custom color used to tint the notification content."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":188,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1986,"name":"count","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The current unread notification count for this application, managed by the device."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":209,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":1984,"name":"imageUrl","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The custom image was provided and displayed in the notification body."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":199,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1985,"name":"link","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"Deep link URL provided to the notification."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":204,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1988,"name":"priority","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The notification priority.","text":"Note; on devices which have channel support (Android 8.0 (API level 26) +),\nthis value will be ignored. Instead, the channel \"importance\" level is used.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":222,"character":14}],"type":{"type":"union","types":[{"type":"reference","name":"PRIORITY_MIN","id":1996},{"type":"reference","name":"PRIORITY_LOW","id":1997},{"type":"reference","name":"PRIORITY_DEFAULT","id":1998},{"type":"reference","name":"PRIORITY_HIGH","id":1999},{"type":"reference","name":"PRIORITY_MAX","id":2000}]}},{"id":1983,"name":"smallIcon","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The custom small icon used to display on the notification. If not set, uses the default\napplication icon defined in the AndroidManifest file."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":194,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1980,"name":"sound","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The sound played when the notification was delivered on the device (channel settings permitted).","text":"Set as \"default\" if the default device notification sound was used.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":177,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1989,"name":"ticker","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"Ticker text set on the notification.","text":"Ticker text is used for devices with accessibility enabled (e.g. to read out the message).\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":234,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1990,"name":"visibility","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The visibility of a notification. This value determines how the notification is shown on the users\ndevices (e.g. on the lock-screen)."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":240,"character":16}],"type":{"type":"union","types":[{"type":"reference","name":"VISIBILITY_SECRET","id":2002},{"type":"reference","name":"VISIBILITY_PRIVATE","id":2003},{"type":"reference","name":"VISIBILITY_PUBLIC","id":2004}]}}],"groups":[{"title":"Variables","kind":32,"children":[1981,1987,1982,1986,1984,1985,1988,1983,1980,1989,1990]}]}}]}},{"id":1972,"name":"body","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The notification body content."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":147,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1973,"name":"ios","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":149,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1974,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1976,"name":"badge","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The value of the badge on the home screen app icon.\nIf not specified, the badge is not changed.\nIf set to 0, the badge has been removed."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":160,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1977,"name":"sound","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The sound played when the notification was delivered on the device (if permissions permit)."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":165,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"NotificationIOSCriticalSound","id":1991}]}},{"id":1975,"name":"subtitle","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The notification's subtitle."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":153,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Variables","kind":32,"children":[1976,1977,1975]}]}}]}},{"id":1971,"name":"title","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The notification title."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":142,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1978,1972,1973,1971]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":138,"character":31}]},{"id":1991,"name":"NotificationIOSCriticalSound","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a critical sound configuration that can be included in the\n`aps` dictionary of an APNs payload."},"children":[{"id":1992,"name":"critical","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The critical alert flag. Set to `true` to enable the critical alert."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":255,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":1993,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The name of a sound file in the app's main bundle or in the `Library/Sounds`\nfolder of the app's container directory. Specify the string \"default\" to play\nthe system sound."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":262,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":1994,"name":"volume","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The volume for the critical alert's sound. Must be a value between 0.0\n(silent) and 1.0 (full volume)."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":268,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1992,1993,1994]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":251,"character":47}]},{"id":1955,"name":"RemoteMessage","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The `RemoteMessage` interface describes an outgoing & incoming message from the remote FCM server."},"children":[{"id":1968,"name":"category","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The iOS category this notification is assigned to.","tags":[{"tag":"platform","text":"ios iOS\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":130,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1956,"name":"collapseKey","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The collapse key a message was sent with. Used to override existing messages with the same\nkey."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":74,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1966,"name":"contentAvailable","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Whether the iOS APNS message was configured as a background update notification.","tags":[{"tag":"platform","text":"ios iOS\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":115,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":1961,"name":"data","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Any additional data sent with the message."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":103,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1962,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1963,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1964,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}]}}]}},{"id":1957,"name":"messageId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A unique ID assigned to every message.","text":"If not provided, a random unique ID is generated.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":81,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1958,"name":"messageType","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The message type of the message."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":86,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1967,"name":"mutableContent","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Whether the iOS APNS `mutable-content` property on the message was set\nallowing the app to modify the notification via app extensions.","tags":[{"tag":"platform","text":"ios iOS\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":123,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":1965,"name":"notification","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Additional Notification data sent with the message"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":108,"character":16}],"type":{"type":"reference","name":"Notification","id":1970}},{"id":1969,"name":"threadId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An iOS app specific identifier used for notification grouping."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":135,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1959,"name":"to","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The address for the message."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":91,"character":6}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1960,"name":"ttl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The time to live for the message in seconds.","text":"Defaults to 3600.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":98,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1968,1956,1966,1961,1957,1958,1967,1965,1969,1959,1960]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":69,"character":32}]},{"id":2017,"name":"SendErrorEvent","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An event that is received when a message fails to send.","text":"### Example\n\n```js\nfirebase.messaging().onSendError(event => {\n  console.log(event.messageId);\n  console.log(event.error);\n});\n"},"children":[{"id":2019,"name":"error","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A native firebase error that indicates the failure reason."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":453,"character":9}],"type":{"type":"reference","name":"NativeFirebaseError","id":2}},{"id":2018,"name":"messageId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The id of the message that failed to send"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":448,"character":13}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2019,2018]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":444,"character":33}]},{"id":1951,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":1952,"name":"AuthorizationStatus","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":61,"character":23}],"type":{"type":"reference","name":"AuthorizationStatus","id":2012}},{"id":1953,"name":"NotificationAndroidPriority","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":62,"character":31}],"type":{"type":"reference","name":"NotificationAndroidPriority","id":1995}},{"id":1954,"name":"NotificationAndroidVisibility","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":63,"character":33}],"type":{"type":"reference","name":"NotificationAndroidVisibility","id":2001}}],"groups":[{"title":"Properties","kind":1024,"children":[1952,1953,1954]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":60,"character":26}]}],"groups":[{"title":"Enumerations","kind":4,"children":[2012,1995,2001]},{"title":"Classes","kind":128,"children":[2020]},{"title":"Interfaces","kind":256,"children":[2005,1970,1991,1955,2017,1951]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":56,"character":39}]},{"id":2536,"name":"FirebasePerformanceTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Performance Monitoring package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `perf` package:\n\n```js\nimport { firebase } from '@react-native-firebase/perf';\n\n// firebase.perf().X\n```\n\n#### Example 2\n\nUsing the default export from the `perf` package:\n\n```js\nimport perf from '@react-native-firebase/perf';\n\n// perf().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/perf';\n\n// firebase.perf().X\n```\n","tags":[{"tag":"firebase","text":"perf\n"}]},"children":[{"id":2568,"name":"HttpMetric","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Metric used to collect data for network requests/responses. A new instance must be used for every request/response."},"children":[{"id":2569,"name":"getAttribute","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2570,"name":"getAttribute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the value of an attribute. Returns null if it does not exist.","text":"#### Example\n\n```js\nconst attribute = metric.getAttribute('user_role');\n```\n"},"parameters":[{"id":2571,"name":"attribute","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the attribute to fetch the value of\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":229,"character":16}]},{"id":2572,"name":"getAttributes","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2573,"name":"getAttributes","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an object of all the currently added attributes.","text":"#### Example\n\n```js\nconst attributes = metric.getAttributes();\n\nattributes.forEach(($) => {\n  console.log($);\n});\n```\n"},"type":{"type":"reflection","declaration":{"id":2574,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":2575,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":2576,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":244,"character":20}]}}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":244,"character":17}]},{"id":2577,"name":"putAttribute","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2578,"name":"putAttribute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a String value for the specified attribute. Updates the value of the attribute if it already exists.\nThe maximum number of attributes that can be added is 5.","text":"#### Example\n\n```js\nmetric.putAttribute('user_role', 'admin');\n```\n"},"parameters":[{"id":2579,"name":"attribute","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the attribute. Max length is 40 chars."},"type":{"type":"intrinsic","name":"string"}},{"id":2580,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Value of the attribute. Max length is 100 chars.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":259,"character":16}]},{"id":2581,"name":"removeAttribute","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2582,"name":"removeAttribute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes an already added attribute. Does nothing if attribute does not exist.","text":"#### Example\n\n```js\nmetric.removeAttribute('user_role');\n```\n"},"parameters":[{"id":2583,"name":"attribute","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the attribute to be removed.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":272,"character":19}]},{"id":2584,"name":"setHttpResponseCode","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2585,"name":"setHttpResponseCode","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the httpResponse code of the request.","text":"#### Example\n\n```js\nconst response = await fetch(url);\nmetric.setHttpResponseCode(response.status);\n```\n> This is required for every request, if you do not provide this your metric will not be captured.\n\n"},"parameters":[{"id":2586,"name":"code","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Value must be greater than 0. Set to null to remove. Invalid usage will be logged natively.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":288,"character":23}]},{"id":2587,"name":"setRequestPayloadSize","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2588,"name":"setRequestPayloadSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the size of the request payload.","text":"#### Example\n\n```js\nconst response = await fetch(url);\nmetric.setRequestPayloadSize(response.headers.get('Content-Type'));\n```\n"},"parameters":[{"id":2589,"name":"bytes","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Value must be greater than 0. Set to null to remove. Invalid usage will be logged natively.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":302,"character":25}]},{"id":2593,"name":"setResponseContentType","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2594,"name":"setResponseContentType","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Content type of the response e.g. `text/html` or `application/json`.","text":"#### Example\n\n```js\nconst response = await fetch(url);\nmetric.setResponsePayloadSize(response.headers.get('Content-Type'));\n```\n"},"parameters":[{"id":2595,"name":"contentType","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Valid string of MIME type. Set to null to remove. Invalid usage will be logged natively.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":330,"character":26}]},{"id":2590,"name":"setResponsePayloadSize","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2591,"name":"setResponsePayloadSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the size of the response payload.","text":"#### Example\n\n```js\nconst response = await fetch(url);\nmetric.setResponsePayloadSize(response.headers.get('Content-Length'));\n```\n"},"parameters":[{"id":2592,"name":"bytes","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Value must be greater than 0. Set to null to remove. Invalid usage will be logged natively.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":316,"character":26}]},{"id":2596,"name":"start","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2597,"name":"start","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Marks the start time of the request. Does nothing if already started.","text":"#### Example\n\n```js\nconst metric = firebase.perf().newHttpMetric('https://api.com/login', 'POST');\nawait metric.start();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":342,"character":9}]},{"id":2598,"name":"stop","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2599,"name":"stop","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Marks the end time of the response and queues the network request metric on the device for transmission. Does nothing if already stopped.","text":"#### Example\n\n```js\nconst metric = firebase.perf().newHttpMetric('https://api.com/login', 'POST');\nawait metric.start();\nmetric.putAttribute('user_role', 'admin');\nawait metric.stop();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":356,"character":8}]}],"groups":[{"title":"Methods","kind":2048,"children":[2569,2572,2577,2581,2584,2587,2593,2590,2596,2598]}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":217,"character":25}]},{"id":2601,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Performance Monitoring service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Performance Monitoring service for the default app:\n\n```js\nconst defaultAppPerf = firebase.perf();\n```\n"},"children":[{"id":2616,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":2602,"name":"isPerformanceCollectionEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Determines whether performance monitoring is enabled or disabled.","text":"#### Example\n\n```js\nconst isEnabled = firebase.perf().isPerformanceCollectionEnabled;\nconsole.log('Performance collection enabled: ', isEnabled);\n```\n"},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":385,"character":34}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2612,"name":"newHttpMetric","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2613,"name":"newHttpMetric","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a HttpMetric instance for collecting network performance data for a single request/response","text":"#### Example\n\n```js\nconst metric = firebase.perf().newHttpMetric('https://api.com/user/1', 'GET');\nawait metric.start();\n```\n"},"parameters":[{"id":2614,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A valid url String, cannot be empty"},"type":{"type":"intrinsic","name":"string"}},{"id":2615,"name":"httpMethod","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"One of the values GET, PUT, POST, DELETE, HEAD, PATCH, OPTIONS, TRACE, or CONNECT\n"},"type":{"type":"reference","name":"HttpMethod","id":2617}}],"type":{"type":"reference","name":"HttpMetric","id":2568}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":441,"character":17}]},{"id":2606,"name":"newTrace","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2607,"name":"newTrace","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Trace instance with the given identifier.","text":"#### Example\n\n```js\nconst trace = firebase.perf().newTrace('user_profile');\nawait trace.start();\n```\n"},"parameters":[{"id":2608,"name":"identifier","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the trace, no leading or trailing whitespace allowed, no leading underscore '_' character allowed, max length is 100.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Trace","id":2537}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":413,"character":12}]},{"id":2603,"name":"setPerformanceCollectionEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2604,"name":"setPerformanceCollectionEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Enables or disables performance monitoring.","text":"#### Example\n\n```js\n// Disable performance monitoring collection\nawait firebase.perf().setPerformanceCollectionEnabled(false);\n```\n"},"parameters":[{"id":2605,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Should performance monitoring be enabled\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":399,"character":35}]},{"id":2609,"name":"startTrace","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2610,"name":"startTrace","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Trace instance with the given identifier and immediately starts it.","text":"#### Example\n\n```js\nconst trace = await firebase.perf().startTrace('user_profile');\n```\n"},"parameters":[{"id":2611,"name":"identifier","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the trace, no leading or trailing whitespace allowed, no leading underscore '_' character allowed, max length is 100.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"Trace","id":2537}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":426,"character":14}]}],"groups":[{"title":"Properties","kind":1024,"children":[2616,2602]},{"title":"Methods","kind":2048,"children":[2612,2606,2603,2609]}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":374,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":2537,"name":"Trace","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Trace allows you to time the beginning to end of a certain action in your app with additional metric values and attributes."},"children":[{"id":2538,"name":"getAttribute","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2539,"name":"getAttribute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the value of an attribute. Returns null if it does not exist.","text":"#### Example\n\n```js\nconst attribute = trace.getAttribute('userId');\n```\n"},"parameters":[{"id":2540,"name":"attribute","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the attribute to fetch the value of.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":97,"character":16}]},{"id":2545,"name":"getMetric","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2546,"name":"getMetric","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the value of the metric with the given name in the current trace. If the metric\ndoesn't exist, it will not be created and a 0 is returned.","text":"#### Example\n\n```js\nconst metric = trace.getMetric('hits');\n```\n"},"parameters":[{"id":2547,"name":"metricName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the metric to get.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"number"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":126,"character":13}]},{"id":2548,"name":"getMetrics","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2549,"name":"getMetrics","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an object of all the currently added metrics and their number values.","text":"#### Example\n\n```js\nconst metrics = trace.getMetrics();\n\nmetrics.forEach(($) => {\n  console.log($);\n});\n```\n"},"type":{"type":"reflection","declaration":{"id":2550,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":2551,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":2552,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"number"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":141,"character":17}]}}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":141,"character":14}]},{"id":2557,"name":"incrementMetric","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2558,"name":"incrementMetric","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Increments the named metric by the `incrementBy` value.","text":"If a metric with the given name doesn't exist, a new one will be created starting with the value of `incrementBy`.\n\n```js\ntrace.incrementMetric('hits', 1);\n```\n"},"parameters":[{"id":2559,"name":"metricName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the metric to increment. Must not have a leading or trailing whitespace, no leading underscore '_' character and have a max length of 32 characters."},"type":{"type":"intrinsic","name":"string"}},{"id":2560,"name":"incrementBy","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value the metric should be incremented by.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":172,"character":19}]},{"id":2541,"name":"putAttribute","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2542,"name":"putAttribute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a String value for the specified attribute. Updates the value of the attribute if it already exists.\nThe maximum number of attributes that can be added is 5.","text":"#### Example\n\n```js\ntrace.putAttribute('userId', '123456789');\n```\n"},"parameters":[{"id":2543,"name":"attribute","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the attribute. Max length is 40 chars."},"type":{"type":"intrinsic","name":"string"}},{"id":2544,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Value of the attribute. Max length is 100 chars.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":112,"character":16}]},{"id":2553,"name":"putMetric","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2554,"name":"putMetric","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the value of the named metric with the provided number.","text":"If a metric with the given name exists it will be overwritten.\nIf a metric with the given name doesn't exist, a new one will be created.\n\n#### Example\n\n```js\ntrace.putMetric('hits', 1);\n```\n"},"parameters":[{"id":2555,"name":"metricName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the metric to set. Must not have a leading or trailing whitespace, no leading underscore '_' character and have a max length of 32 characters."},"type":{"type":"intrinsic","name":"string"}},{"id":2556,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value the metric should be set to.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":158,"character":13}]},{"id":2561,"name":"removeMetric","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2562,"name":"removeMetric","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes a metric by name if it exists.","text":"#### Example\n\n```js\ntrace.removeMetric('hits');\n```\n"},"parameters":[{"id":2563,"name":"metricName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the metric to remove.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":185,"character":16}]},{"id":2564,"name":"start","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2565,"name":"start","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Marks the start time of the trace. Does nothing if already started.","text":"#### Example\n\n```js\nconst trace = firebase.perf().newTrace('example');\nawait trace.start();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":197,"character":9}]},{"id":2566,"name":"stop","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2567,"name":"stop","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Marks the end time of the trace and queues the metric on the device for transmission. Does nothing if already stopped.","text":"* #### Example\n\n```js\nconst trace = firebase.perf().newTrace('example');\nawait trace.start();\ntrace.putMetric('hits', 1);\nawait trace.stop();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":211,"character":8}]}],"groups":[{"title":"Methods","kind":2048,"children":[2538,2545,2548,2557,2541,2553,2561,2564,2566]}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":85,"character":20}]},{"id":2600,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":359,"character":26}]},{"id":2617,"name":"HttpMethod","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"Valid HTTP methods."},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":71,"character":24}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"GET"},{"type":"stringLiteral","value":"HEAD"},{"type":"stringLiteral","value":"PUT"},{"type":"stringLiteral","value":"POST"},{"type":"stringLiteral","value":"PATCH"},{"type":"stringLiteral","value":"TRACE"},{"type":"stringLiteral","value":"DELETE"},{"type":"stringLiteral","value":"CONNECT"},{"type":"stringLiteral","value":"OPTIONS"}]}}],"groups":[{"title":"Classes","kind":128,"children":[2568,2601,2537]},{"title":"Interfaces","kind":256,"children":[2600]},{"title":"Type aliases","kind":4194304,"children":[2617]}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":56,"character":41}]},{"id":2626,"name":"FirebaseRemoteConfigTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Remote RemoteConfig package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `config` package:\n\n```js\nimport { firebase } from '@react-native-firebase/remote-config';\n\n// firebase.remoteConfig().X\n```\n\n#### Example 2\n\nUsing the default export from the `config` package:\n\n```js\nimport remoteConfig from '@react-native-firebase/remote-config';\n\n// remoteConfig().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/remote-config';\n\n// firebase.remoteConfig().X\n```\n","tags":[{"tag":"firebase","text":"remote-config\n"}]},"children":[{"id":2651,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Remote RemoteConfig service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Remote RemoteConfig service for the default app:\n\n```js\nconst defaultAppRemoteConfig = firebase.remoteConfig();\n```\n"},"children":[{"id":2676,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":2653,"name":"isDeveloperModeEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Whether developer mode is enabled. This is set manually via {@link config#setConfigSettings}"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":287,"character":26}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2654,"name":"lastFetchStatus","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The status of the latest Remote RemoteConfig fetch action.","text":"See the `LastFetchStatus` statics definition.\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":293,"character":19}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"success"},{"type":"stringLiteral","value":"failure"},{"type":"stringLiteral","value":"no_fetch_yet"},{"type":"stringLiteral","value":"throttled"}]}},{"id":2652,"name":"lastFetchTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The number of milliseconds since the last Remote RemoteConfig fetch was performed."},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":283,"character":17}],"type":{"type":"intrinsic","name":"number"}},{"id":2655,"name":"activate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2656,"name":"activate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Moves fetched data to the apps active config.\nResolves with a boolean value of whether the fetched config was moved successfully.","text":"#### Example\n\n```js\n// Fetch values\nawait firebase.remoteConfig().fetch();\nconst activated = await firebase.remoteConfig().activate();\n\nif (activated) {\n console.log('Fetched values successfully activated.');\n} else {\n  console.log('Fetched values failed to activate.');\n}\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"boolean"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":313,"character":12}]},{"id":2657,"name":"fetch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2658,"name":"fetch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Fetches the remote config data from Firebase, as defined in the dashboard. If duration is defined (seconds), data will be locally cached for this duration.","text":"#### Example\n\n```js\n// Fetch and cache for 5 minutes\nawait firebase.remoteConfig().fetch(300);\n```\n"},"parameters":[{"id":2659,"name":"expirationDurationSeconds","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Duration in seconds to cache the data for. To skip cache, use a duration of 0.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":327,"character":9}]},{"id":2660,"name":"fetchAndActivate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2661,"name":"fetchAndActivate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Fetches the remote config data from Firebase, as defined in the dashboard.","text":"Once fetching is complete this method immediately calls activate and returns a boolean value of the activation status.\n\n#### Example\n\n```js\n// Fetch, cache for 5 minutes and activate\nconst activated = await firebase.remoteConfig().fetchAndActivate();\n\nif (activated) {\n console.log('Fetched values successfully activated.');\n} else {\n  console.log('Fetched values failed to activate.');\n}\n```\n\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"boolean"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":348,"character":20}]},{"id":2662,"name":"getAll","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2663,"name":"getAll","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns all available config values.","text":"#### Example\n\n```js\nconst values = firebase.remoteConfig().getAll();\n\nObject.entries(values).forEach(($) => {\n  const [key, entry] = $;\n  console.log('Key: ', key);\n  console.log('Source: ', entry.source);\n  console.log('Value: ', entry.value);\n});\n```\n\n"},"type":{"type":"reference","name":"ConfigValues","id":2642}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":367,"character":10}]},{"id":2664,"name":"getValue","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2665,"name":"getValue","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a ConfigValue by key.","text":"#### Example\n\n```js\nconst configValue = firebase.remoteConfig().getValue('experiment');\nconsole.log('Source: ', configValue.source);\nconsole.log('Value: ', configValue.value);\n```\n"},"parameters":[{"id":2666,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A key used to retrieve a specific value.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"ConfigValue","id":2639}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":382,"character":12}]},{"id":2667,"name":"setConfigSettings","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2668,"name":"setConfigSettings","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Set the Remote RemoteConfig settings, specifically the `isDeveloperModeEnabled` flag.","text":"#### Example\n\n```js\nawait firebase.remoteConfig().setConfigSettings({\n  isDeveloperModeEnabled: __DEV__,\n});\n```\n"},"parameters":[{"id":2669,"name":"configSettings","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A ConfigSettingsWrite instance used to set Remote RemoteConfig settings.\n"},"type":{"type":"reference","name":"ConfigSettings","id":2645}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":397,"character":21}]},{"id":2670,"name":"setDefaults","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2671,"name":"setDefaults","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets default values for the app to use when accessing values.\nAny data fetched and activated will override any default values. Any values in the defaults but not on Firebase will be untouched.","text":"#### Example\n\n```js\nawait firebase.remoteConfig().setDefaults({\n  experiment_enabled: false,\n});\n```\n"},"parameters":[{"id":2672,"name":"defaults","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A ConfigDefaults instance used to set default values.\n"},"type":{"type":"reference","name":"ConfigDefaults","id":2648}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":413,"character":15}]},{"id":2673,"name":"setDefaultsFromResource","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2674,"name":"setDefaultsFromResource","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the default values from a resource file.\nOn iOS this is a plist file and on Android this is an XML defaultsMap file.","text":"```js\n // TODO @ehesp\n```\n"},"parameters":[{"id":2675,"name":"resourceName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The plist/xml file name with no extension.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":425,"character":27}]}],"groups":[{"title":"Properties","kind":1024,"children":[2676,2653,2654,2652]},{"title":"Methods","kind":2048,"children":[2655,2657,2660,2662,2664,2667,2670,2673]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":279,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":2648,"name":"ConfigDefaults","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An Interface representing a RemoteConfig Defaults object.","text":"#### Example\n\n```js\nawait firebase.remoteConfig().setDefaults({\n  experiment_enabled: false,\n});\n```\n"},"indexSignature":[{"id":2649,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"comment":{"shortText":"An Interface representing a RemoteConfig Defaults object.","text":"#### Example\n\n```js\nawait firebase.remoteConfig().setDefaults({\n  experiment_enabled: false,\n});\n```\n"},"parameters":[{"id":2650,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":262,"character":33}]},{"id":2645,"name":"ConfigSettings","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An Interface representing settable config settings.","text":"#### Example\n\nThe example below makes use of the React Native `__DEV__` global JavaScript variable which\nis exposed.\n\n```js\nawait firebase.remoteConfig().setConfigSettings({\n  isDeveloperModeEnabled: __DEV__,\n});\n```\n"},"children":[{"id":2646,"name":"isDeveloperModeEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If enabled, default behaviour such as caching is disabled for a better debugging\nexperience."},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":244,"character":26}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2647,"name":"minimumFetchInterval","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The time that remote config should cache flags for."},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":248,"character":24}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2646,2647]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":239,"character":33}]},{"id":2639,"name":"ConfigValue","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An Interface representing a Remote RemoteConfig value."},"children":[{"id":2640,"name":"source","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Where the value was retrieved from.","text":"- `remote`:  If the value was retrieved from the server.\n- `default`: If the value was set as a default value.\n- `static`: If no value was found and a static default value was returned instead.\n\nSee the `ValueSource` statics definition.\n\n#### Example\n\n```js\nconst configValue = firebase.remoteConfig().getValue('beta_enabled');\nconsole.log('Value source: ', configValue.source);\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":197,"character":10}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"remote"},{"type":"stringLiteral","value":"default"},{"type":"stringLiteral","value":"static"}]}},{"id":2641,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The returned value.","text":"#### Example\n\n```js\nconst configValue = firebase.remoteConfig().getValue('beta_enabled');\nconsole.log('Value: ', configValue.value);\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":209,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2640,2641]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":180,"character":30}]},{"id":2642,"name":"ConfigValues","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An Interface representing multiple RemoteConfig Values.","text":"#### Example\n\n```js\nconst values = firebase.remoteConfig().getAll();\n```\n"},"indexSignature":[{"id":2643,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"comment":{"shortText":"An Interface representing multiple RemoteConfig Values.","text":"#### Example\n\n```js\nconst values = firebase.remoteConfig().getAll();\n```\n"},"parameters":[{"id":2644,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"ConfigValue","id":2639}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":221,"character":31}]},{"id":2627,"name":"LastFetchStatus","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A pseudo-enum for usage with ConfigSettingsRead.lastFetchStatus to determine the last fetch status.","text":"#### Example\n\n```js\nfirebase.remoteConfig.LastFetchStatus;\n```\n"},"children":[{"id":2629,"name":"FAILURE","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A value indicating that the last fetch failed.","text":"```js\nfirebase.remoteConfig.LastFetchStatus.FAILURE;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":85,"character":11}],"type":{"type":"stringLiteral","value":"failure"}},{"id":2631,"name":"NO_FETCH_YET","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A value indicating that no fetches have occurred yet.","text":"This usually means you've not called fetch yet.\n\n```js\nfirebase.remoteConfig.LastFetchStatus.NO_FETCH_YET;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":107,"character":16}],"type":{"type":"stringLiteral","value":"no_fetch_yet"}},{"id":2628,"name":"SUCCESS","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A value indicating that the last fetch was successful.","text":"```js\nfirebase.remoteConfig.LastFetchStatus.SUCCESS;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":76,"character":11}],"type":{"type":"stringLiteral","value":"success"}},{"id":2630,"name":"THROTTLED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A value indicating that the last fetch was throttled.","text":"This usually occurs when calling fetch often with a low expiration duration.\n\n```js\nfirebase.remoteConfig.LastFetchStatus.THROTTLED;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":96,"character":13}],"type":{"type":"stringLiteral","value":"throttled"}}],"groups":[{"title":"Properties","kind":1024,"children":[2629,2631,2628,2630]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":68,"character":34}]},{"id":2636,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Firebase Remote RemoteConfig statics.","text":"```js\nfirebase.config;\n```\n"},"children":[{"id":2638,"name":"LastFetchStatus","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A pseudo-enum for usage with `firebase.remoteConfig().lastFetchStatus` to determine the last fetch status.","text":"#### Example\n\n```js\nfirebase.remoteConfig.LastFetchStatus;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":174,"character":19}],"type":{"type":"reference","name":"LastFetchStatus","id":2627}},{"id":2637,"name":"ValueSource","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A pseudo-enum for usage with ConfigValue.source to determine the value source.","text":"#### Example\n\n```js\nfirebase.remoteConfig.ValueSource;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":163,"character":15}],"type":{"type":"reference","name":"ValueSource","id":2632}}],"groups":[{"title":"Properties","kind":1024,"children":[2638,2637]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":153,"character":26}]},{"id":2632,"name":"ValueSource","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A pseudo-enum for usage with ConfigValue.source to determine the value source.","text":"#### Example\n\n```js\nfirebase.remoteConfig.ValueSource;\n```\n"},"children":[{"id":2634,"name":"DEFAULT","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If the value was set as a default value.","text":"```js\nfirebase.remoteConfig.ValueSource.DEFAULT;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":135,"character":11}],"type":{"type":"stringLiteral","value":"default"}},{"id":2633,"name":"REMOTE","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If the value was retrieved from the server.","text":"```js\nfirebase.remoteConfig.ValueSource.REMOTE;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":127,"character":10}],"type":{"type":"stringLiteral","value":"remote"}},{"id":2635,"name":"STATIC","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If no value was found and a static default value was returned instead.","text":"```js\nfirebase.remoteConfig.ValueSource.STATIC;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":143,"character":10}],"type":{"type":"stringLiteral","value":"static"}}],"groups":[{"title":"Properties","kind":1024,"children":[2634,2633,2635]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":119,"character":30}]}],"groups":[{"title":"Classes","kind":128,"children":[2651]},{"title":"Interfaces","kind":256,"children":[2648,2645,2639,2642,2627,2636,2632]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":56,"character":42}]},{"id":2684,"name":"FirebaseStorageTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Cloud Storage package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `storage` package:\n\n```js\nimport { firebase } from '@react-native-firebase/storage';\n\n// firebase.storage().X\n```\n\n#### Example 2\n\nUsing the default export from the `storage` package:\n\n```js\nimport storage from '@react-native-firebase/storage';\n\n// storage().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/storage';\n\n// firebase.storage().X\n```\n","tags":[{"tag":"firebase","text":"storage\n"}]},"children":[{"id":2840,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Cloud Storage service is available for the default app, a given app or a specific storage bucket.","text":"#### Example 1\n\nGet the storage instance for the **default app**:\n\n```js\nconst storageForDefaultApp = firebase.storage();\n```\n\n#### Example 2\n\nGet the storage instance for a **secondary app**:\n\n```js\nconst otherApp = firebase.app('otherApp');\nconst storageForOtherApp = firebase.storage(otherApp);\n```\n\n#### Example 3\n\nGet the storage instance for a **specific storage bucket**:\n\n```js\nconst defaultApp = firebase.app();\nconst storageForBucket = defaultApp.storage('gs://another-bucket-url');\n\nconst otherApp = firebase.app('otherApp');\nconst storageForOtherAppBucket = otherApp.storage('gs://another-bucket-url');\n```\n\n"},"children":[{"id":2859,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":2845,"name":"maxDownloadRetryTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the current maximum time in milliseconds to retry a download if a failure occurs.","text":"#### Example\n\n```js\nconst downloadRetryTime = firebase.storage().maxUploadRetryTime;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1026,"character":24}],"type":{"type":"intrinsic","name":"number"}},{"id":2849,"name":"maxOperationRetryTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the current maximum time in milliseconds to retry operations other than upload and download if a failure occurs.","text":"#### Example\n\n```js\nconst maxOperationRetryTime = firebase.storage().maxOperationRetryTime;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1050,"character":25}],"type":{"type":"intrinsic","name":"number"}},{"id":2841,"name":"maxUploadRetryTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the current maximum time in milliseconds to retry an upload if a failure occurs.","text":"#### Example\n\n```js\nconst uploadRetryTime = firebase.storage().maxUploadRetryTime;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1002,"character":22}],"type":{"type":"intrinsic","name":"number"}},{"id":2853,"name":"ref","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2854,"name":"ref","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a new {@link storage.Reference} instance.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('cats.gif');\n```\n"},"parameters":[{"id":2855,"name":"path","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional string pointing to a location on the storage bucket. If no path\nis provided, the returned reference will be the bucket root path.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Reference","id":2731}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1077,"character":7}]},{"id":2856,"name":"refFromURL","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2857,"name":"refFromURL","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a new {@link storage.Reference} instance from a storage bucket URL.","text":"#### Example\n\n```js\nconst gsUrl = 'gs://react-native-firebase-testing/cats.gif';\nconst httpUrl = 'https://firebasestorage.googleapis.com/v0/b/react-native-firebase-testing.appspot.com/o/cats.gif';\n\nconst refFromGsUrl = firebase.storage().refFromURL(gsUrl);\n// or\nconst refFromHttpUrl = firebase.storage().refFromURL(httpUrl);\n```\n"},"parameters":[{"id":2858,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A storage bucket URL pointing to a single file or location. Must be either a `gs://` url or an `http` url,\ne.g. `gs://assets/logo.png` or `https://firebasestorage.googleapis.com/v0/b/react-native-firebase-testing.appspot.com/o/cats.gif`.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Reference","id":2731}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1096,"character":14}]},{"id":2846,"name":"setMaxDownloadRetryTime","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2847,"name":"setMaxDownloadRetryTime","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the maximum time in milliseconds to retry a download if a failure occurs.","text":"#### Example\n\n```js\nawait firebase.storage().setMaxDownloadRetryTime(25000);\n```\n"},"parameters":[{"id":2848,"name":"time","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new maximum download retry time in milliseconds.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1039,"character":27}]},{"id":2850,"name":"setMaxOperationRetryTime","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2851,"name":"setMaxOperationRetryTime","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the maximum time in milliseconds to retry operations other than upload and download if a failure occurs.","text":"#### Example\n\n```js\nawait firebase.storage().setMaxOperationRetryTime(5000);\n```\n"},"parameters":[{"id":2852,"name":"time","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new maximum operation retry time in milliseconds.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1063,"character":28}]},{"id":2842,"name":"setMaxUploadRetryTime","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2843,"name":"setMaxUploadRetryTime","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the maximum time in milliseconds to retry an upload if a failure occurs.","text":"#### Example\n\n```js\nawait firebase.storage().setMaxUploadRetryTime(25000);\n```\n"},"parameters":[{"id":2844,"name":"time","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new maximum upload retry time in milliseconds.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1015,"character":25}]}],"groups":[{"title":"Properties","kind":1024,"children":[2859,2845,2849,2841]},{"title":"Methods","kind":2048,"children":[2853,2856,2846,2850,2842]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":992,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":2712,"name":"FullMetadata","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The full readable metadata returned by `TaskSnapshot.metadata` or `StorageReference.getMetadata()`."},"children":[{"id":2714,"name":"bucket","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The bucket this storage object is contained in.","text":"#### Example Value\n\n```\ngs://my-project-storage-bucket\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":357,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":2722,"name":"cacheControl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Cache-Control' HTTP header that will be set on the storage object when it's requested.","text":"#### Example 1\n\nTo turn off caching, you can set the following cacheControl value.\n\n```js\n{\n  cacheControl: 'no-store',\n}\n```\n\n#### Example 2\n\nTo aggressively cache an object, e.g. static assets, you can set the following cacheControl value.\n\n```js\n{\n  cacheControl: 'public, max-age=31536000',\n}\n```\n\n[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":272,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"SettableMetadata.cacheControl","id":2703}},{"id":2723,"name":"contentDisposition","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Disposition' HTTP header that will be set on the storage object when it's requested.","text":"[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":279,"character":22}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"SettableMetadata.contentDisposition","id":2704}},{"id":2724,"name":"contentEncoding","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Encoding' HTTP header that will be used on the storage object when it's requested.","text":"[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":286,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"SettableMetadata.contentEncoding","id":2705}},{"id":2725,"name":"contentLanguage","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Language' HTTP header that will be set on the storage object when it's requested.","text":"[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Language)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":293,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"SettableMetadata.contentLanguage","id":2706}},{"id":2726,"name":"contentType","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Type' HTTP header that will be set on the object when it's requested.","text":"This is used to indicate the media type (or MIME type) of the object. When uploading a file\nFirebase Cloud Storage for React Native will attempt to automatically detect this if `contentType`\nis not already set, if it fails to detect a media type it will default to `application/octet-stream`.\n\nFor `DATA_URL` string formats uploaded via `putString` this will also be automatically extracted if available.\n\n#### Example\n\nSetting the content type as JSON, e.g. for when uploading a JSON string via `putString`.\n\n```js\n{\n  contentType: 'application/json',\n}\n```\n\n[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":316,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"SettableMetadata.contentType","id":2707}},{"id":2727,"name":"customMetadata","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Additional user-defined custom metadata for this storage object.","text":"String values only are supported for custom metadata property values.\n\n#### Example\n\nAdding a user controlled NSFW meta data field.\n\n```js\n{\n  customMetadata: {\n    'nsfw': 'true'\n  },\n}\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":334,"character":18}],"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2728,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":2729,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":2730,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":334,"character":20}]}},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"SettableMetadata.customMetadata","id":2708}},{"id":2715,"name":"fullPath","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The full path to this storage object in its bucket.","text":"#### Example Value\n\n```\ninvertase/logo.png\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":368,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":2716,"name":"generation","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Storage object generation values enable users to uniquely identify data resources, e.g. object versioning.","text":"Read more on generation on the [Google Cloud Storage documentation](https://cloud.google.com/storage/docs/generations-preconditions).\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":375,"character":14}],"type":{"type":"intrinsic","name":"string"}},{"id":2713,"name":"md5Hash","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A Base64-encoded MD5 hash of the storage object being uploaded."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":346,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2717,"name":"metageneration","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Storage object metageneration values enable users to uniquely identify data resources, e.g. object versioning.","text":"Read more on metageneration on the [Google Cloud Storage documentation](https://cloud.google.com/storage/docs/generations-preconditions).\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":382,"character":18}],"type":{"type":"intrinsic","name":"string"}},{"id":2718,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The short name of storage object in its bucket, e.g. it's file name.","text":"#### Example Value\n\n```\nlogo.png\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":393,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":2719,"name":"size","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The size of this storage object in bytes."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":398,"character":8}],"type":{"type":"intrinsic","name":"number"}},{"id":2720,"name":"timeCreated","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A date string representing when this storage object was created.","text":"#### Example Value\n\n```\n2019-05-02T00:34:56.264Z\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":409,"character":15}],"type":{"type":"intrinsic","name":"string"}},{"id":2721,"name":"updated","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A date string representing when this storage object was last updated.","text":"#### Example Value\n\n```\n2019-05-02T00:35:56.264Z\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":420,"character":11}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2714,2722,2723,2724,2725,2726,2727,2715,2716,2713,2717,2718,2719,2720,2721]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":342,"character":31}],"extendedTypes":[{"type":"reference","name":"SettableMetadata","id":2702}]},{"id":2833,"name":"ListOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The options `list()` accepts."},"children":[{"id":2834,"name":"maxResults","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If set, limits the total number of `prefixes` and `items` to return. The default and maximum maxResults is 1000."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":929,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":2835,"name":"pageToken","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The `nextPageToken` from a previous call to `list()`. If provided, listing is resumed from the previous position."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":934,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2834,2835]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":925,"character":30}]},{"id":2836,"name":"ListResult","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Result returned by `list()`."},"children":[{"id":2837,"name":"items","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Objects in this directory. You can call `getMetadate()` and `getDownloadUrl()` on them."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":944,"character":9}],"type":{"type":"array","elementType":{"type":"reference","name":"Reference","id":2731}}},{"id":2838,"name":"nextPageToken","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If set, there might be more results for this list. Use this token to resume the list."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":949,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2839,"name":"prefixes","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"References to prefixes (sub-folders). You can call `list()` on them to get its contents.","text":"Folders are implicit based on '/' in the object paths. For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a') will return '/a/b' as a prefix.\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":956,"character":12}],"type":{"type":"array","elementType":{"type":"reference","name":"Reference","id":2731}}}],"groups":[{"title":"Properties","kind":1024,"children":[2837,2838,2839]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":940,"character":29}]},{"id":2731,"name":"Reference","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a reference to a Google Cloud Storage object in React Native Firebase.","text":"A reference can be used to upload and download storage objects, get/set storage object metadata, retrieve storage object download urls and delete storage objects.\n\n#### Example 1\n\nGet a reference to a specific storage path.\n\n```js\nconst ref = firebase.storage().ref('invertase/logo.png');\n```\n\n#### Example 2\n\nGet a reference to a specific storage path on another bucket in the same firebase project.\n\n```js\nconst ref = firebase.storage().refFromURL('gs://other-bucket/invertase/logo.png');\n```\n"},"children":[{"id":2732,"name":"bucket","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The name of the bucket containing this reference's object."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":448,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":2734,"name":"fullPath","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The full path of this object."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":456,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":2735,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The short name of this object, which is the last component of the full path. For example,\nif fullPath is 'full/path/image.png', name is 'image.png'."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":461,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":2733,"name":"parent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A reference pointing to the parent location of this reference, or null if this reference is the root."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":452,"character":10}],"type":{"type":"union","types":[{"type":"reference","name":"Reference","id":2731},{"type":"intrinsic","name":"null"}]}},{"id":2736,"name":"root","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A reference to the root of this reference's bucket."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":465,"character":8}],"type":{"type":"reference","name":"Reference","id":2731}},{"id":2737,"name":"storage","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The storage service associated with this reference."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":469,"character":11}],"type":{"type":"reference","name":"Module","id":2840}},{"id":2740,"name":"child","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2741,"name":"child","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a reference to a relative path from this reference.","text":"#### Example\n\n```js\nconst parent = firebase.storage().ref('invertase');\nconst ref = parent.child('logo.png');\n```\n"},"parameters":[{"id":2742,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The relative path from this reference. Leading, trailing, and consecutive slashes are removed.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Reference","id":2731}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":495,"character":9}]},{"id":2743,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2744,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deletes the object at this reference's location.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/logo.png');\nawait ref.delete();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":507,"character":10}]},{"id":2745,"name":"getDownloadURL","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2746,"name":"getDownloadURL","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Fetches a long lived download URL for this object.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/logo.png');\nconst url = await ref.getDownloadURL();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":519,"character":18}]},{"id":2747,"name":"getMetadata","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2748,"name":"getMetadata","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Fetches metadata for the object at this location, if one exists.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/logo.png');\nconst metadata = await ref.getMetadata();\nconsole.log('Cache control: ', metadata.cacheControl);\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"FullMetadata","id":2712}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":532,"character":15}]},{"id":2749,"name":"list","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2750,"name":"list","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"List items (files) and prefixes (folders) under this storage reference.","text":"List API is only available for Firebase Rules Version 2.\n\nGCS is a key-blob store. Firebase Storage imposes the semantic of '/' delimited folder structure.\nRefer to GCS's List API if you want to learn more.\n\nTo adhere to Firebase Rules's Semantics, Firebase Storage does not support objects whose paths\nend with \"/\" or contain two consecutive \"/\"s. Firebase Storage List API will filter these unsupported objects.\nlist() may fail if there are too many unsupported objects in the bucket.\n\n#### Example\n\n```js\nconst ref = firebase.storage().ref('/');\nconst results = await ref.list({\n  maxResults: 30,\n});\n```\n"},"parameters":[{"id":2751,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional ListOptions interface.\n"},"type":{"type":"reference","name":"ListOptions","id":2833}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"ListResult","id":2836}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":557,"character":8}]},{"id":2752,"name":"listAll","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2753,"name":"listAll","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"List all items (files) and prefixes (folders) under this storage reference.","text":"This is a helper method for calling list() repeatedly until there are no more results. The default pagination size is 1000.\n\nNote: The results may not be consistent if objects are changed while this operation is running.\n\nWarning: `listAll` may potentially consume too many resources if there are too many results.\n\n#### Example\n\n```js\nconst ref = firebase.storage().ref('/');\nconst results = await ref.listAll();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"ListResult","id":2836}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":575,"character":11}]},{"id":2761,"name":"put","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2762,"name":"put","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Puts data onto the storage bucket.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/new-logo.png');\nconst task = ref.put(BLOB, {\n  cacheControl: 'no-store', // disable caching\n});\n```\n"},"parameters":[{"id":2763,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The data to upload to the storage bucket at the reference location."},"type":{"type":"union","types":[{"type":"reference","name":"Blob"},{"type":"reference","name":"Uint8Array"},{"type":"reference","name":"ArrayBuffer"}]}},{"id":2764,"name":"metadata","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"\n"},"type":{"type":"reference","name":"SettableMetadata","id":2702}}],"type":{"type":"reference","name":"Task","id":2785}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":626,"character":7}]},{"id":2754,"name":"putFile","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2755,"name":"putFile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Puts a file from local disk onto the storage bucket.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/new-logo.png');\nconst path = `${firebase.utils.FilePath.DOCUMENT_DIRECTORY}/new-logo.png`;\nconst task = ref.putFile(path, {\n  cacheControl: 'no-store', // disable caching\n});\n```\n"},"parameters":[{"id":2756,"name":"localFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The local file path to upload to the bucket at the reference location."},"type":{"type":"intrinsic","name":"string"}},{"id":2757,"name":"metadata","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Any additional `SettableMetadata` for this task.\n"},"type":{"type":"reference","name":"SettableMetadata","id":2702}}],"type":{"type":"reference","name":"Task","id":2785}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":593,"character":11}]},{"id":2765,"name":"putString","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2766,"name":"putString","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Puts a string on the storage bucket. Depending on the string type, set a {@link storage.StringFormat} type.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/new-logo.png');\nconst task = ref.putString('PEZvbyBCYXI+', firebase.storage.StringFormat.BASE64, {\n  cacheControl: 'no-store', // disable caching\n});\n```\n"},"parameters":[{"id":2767,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The string data, must match the format provided."},"type":{"type":"intrinsic","name":"string"}},{"id":2768,"name":"format","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The format type of the string, e.g. a Base64 format string."},"type":{"type":"union","types":[{"type":"stringLiteral","value":"raw"},{"type":"stringLiteral","value":"base64"},{"type":"stringLiteral","value":"base64url"},{"type":"stringLiteral","value":"data_url"}]}},{"id":2769,"name":"metadata","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Any additional `SettableMetadata` for this task.\n"},"type":{"type":"reference","name":"SettableMetadata","id":2702}}],"type":{"type":"reference","name":"Task","id":2785}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":644,"character":13}]},{"id":2738,"name":"toString","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2739,"name":"toString","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a gs:// URL for this object in the form `gs://<bucket>/<path>/<to>/<object>`.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/logo.png');\nconsole.log('Full path: ', ref.toString()); // gs://invertase.io/invertase/logo.png\n```\n"},"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":481,"character":12}]},{"id":2770,"name":"updateMetadata","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2771,"name":"updateMetadata","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates the metadata for this reference object on the storage bucket.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/nsfw-logo.png');\nconst updatedMetadata = await ref.updateMetadata({\n  customMetadata: {\n    'nsfw': 'true',\n  }\n});\n```\n"},"parameters":[{"id":2772,"name":"metadata","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A `SettableMetadata` instance to update.\n"},"type":{"type":"reference","name":"SettableMetadata","id":2702}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"FullMetadata","id":2712}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":666,"character":18}]},{"id":2758,"name":"writeToFile","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2759,"name":"writeToFile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Downloads a file to the specified local file path on the device.","text":"#### Example\n\nGet a Download Storage task to download a file:\n\n```js\nconst downloadTo = `${firebase.utils.FilePath.DOCUMENT_DIRECTORY}/foobar.json`;\n\nconst task = firebase.storage().ref('/foo/bar.json').writeToFile(downloadTo);\n```"},"parameters":[{"id":2760,"name":"localFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Task","id":2785}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":609,"character":15}]}],"groups":[{"title":"Properties","kind":1024,"children":[2732,2734,2735,2733,2736,2737]},{"title":"Methods","kind":2048,"children":[2740,2743,2745,2747,2749,2752,2761,2754,2765,2738,2770,2758]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":444,"character":28}]},{"id":2702,"name":"SettableMetadata","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An interface representing all the metadata properties that can be set.","text":"This is used in updateMetadata, put, putString & putFile.\n"},"children":[{"id":2703,"name":"cacheControl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Cache-Control' HTTP header that will be set on the storage object when it's requested.","text":"#### Example 1\n\nTo turn off caching, you can set the following cacheControl value.\n\n```js\n{\n  cacheControl: 'no-store',\n}\n```\n\n#### Example 2\n\nTo aggressively cache an object, e.g. static assets, you can set the following cacheControl value.\n\n```js\n{\n  cacheControl: 'public, max-age=31536000',\n}\n```\n\n[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":272,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2704,"name":"contentDisposition","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Disposition' HTTP header that will be set on the storage object when it's requested.","text":"[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":279,"character":22}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2705,"name":"contentEncoding","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Encoding' HTTP header that will be used on the storage object when it's requested.","text":"[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":286,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2706,"name":"contentLanguage","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Language' HTTP header that will be set on the storage object when it's requested.","text":"[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Language)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":293,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2707,"name":"contentType","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Type' HTTP header that will be set on the object when it's requested.","text":"This is used to indicate the media type (or MIME type) of the object. When uploading a file\nFirebase Cloud Storage for React Native will attempt to automatically detect this if `contentType`\nis not already set, if it fails to detect a media type it will default to `application/octet-stream`.\n\nFor `DATA_URL` string formats uploaded via `putString` this will also be automatically extracted if available.\n\n#### Example\n\nSetting the content type as JSON, e.g. for when uploading a JSON string via `putString`.\n\n```js\n{\n  contentType: 'application/json',\n}\n```\n\n[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":316,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2708,"name":"customMetadata","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Additional user-defined custom metadata for this storage object.","text":"String values only are supported for custom metadata property values.\n\n#### Example\n\nAdding a user controlled NSFW meta data field.\n\n```js\n{\n  customMetadata: {\n    'nsfw': 'true'\n  },\n}\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":334,"character":18}],"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2709,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":2710,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":2711,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":334,"character":20}]}},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2703,2704,2705,2706,2707,2708]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":246,"character":35}],"extendedBy":[{"type":"reference","name":"FullMetadata","id":2712}]},{"id":2698,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Cloud Storage statics.","text":"#### Example\n\n```js\nfirebase.storage;\n```\n"},"children":[{"id":2699,"name":"StringFormat","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Possible string formats used for uploading via `StorageReference.putString()`","text":"#### Example\n\n```js\nfirebase.storage.StringFormat;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":216,"character":16}],"type":{"type":"reference","name":"StringFormat","id":2685}},{"id":2701,"name":"TaskEvent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An event to subscribe to that is triggered on a Upload or Download task.","text":"#### Example\n\n```js\nfirebase.storage.TaskEvent;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":238,"character":13}],"type":{"type":"reference","name":"TaskEvent","id":2690}},{"id":2700,"name":"TaskState","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A collection of properties that indicates the current tasks state.","text":"#### Example\n\n```js\nfirebase.storage.TaskState;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":227,"character":13}],"type":{"type":"reference","name":"TaskState","id":2692}}],"groups":[{"title":"Properties","kind":1024,"children":[2699,2701,2700]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":206,"character":26}]},{"id":2685,"name":"StringFormat","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Possible string formats used for uploading via `StorageReference.putString()`","text":"```js\nfirebase.storage.StringFormat;\n```\n"},"children":[{"id":2687,"name":"BASE64","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Base64 string format.","text":"Learn more about Base64 [on the Mozilla Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WindowBase64/Base64_encoding_and_decoding)\n\n#### Usage\n\n```js\nfirebase.storage.StringFormat.BASE64;\n```\n\n#### Example String Format\n\n```js\nconst sampleString = 'PEZvbyBCYXI+';\n```\n\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":103,"character":10}],"type":{"type":"stringLiteral","value":"base64"}},{"id":2688,"name":"BASE64URL","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Base64Url string format.","text":"#### Usage\n\n```js\nfirebase.storage.StringFormat.BASE64URL;\n```\n\n#### Example String Format\n\n```js\nconst sampleString = 'PEZvbyBCYXI-';\n```\n\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":121,"character":13}],"type":{"type":"stringLiteral","value":"base64url"}},{"id":2689,"name":"DATA_URL","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Data URL string format.","text":"#### Usage\n\n```js\nfirebase.storage.StringFormat.DATA_URL;\n```\n\n#### Example String Format\n\n```js\nconst sampleString = 'data:text/plain;base64,PEZvbyBCYXI+';\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":138,"character":12}],"type":{"type":"stringLiteral","value":"data_url"}},{"id":2686,"name":"RAW","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Raw string format.","text":"#### Usage\n\n```js\nfirebase.storage.StringFormat.RAW;\n```\n\n#### Example String Format\n\n```js\nconst sampleString = '<Foo Bar>';\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":83,"character":7}],"type":{"type":"stringLiteral","value":"raw"}}],"groups":[{"title":"Properties","kind":1024,"children":[2687,2688,2689,2686]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":67,"character":31}]},{"id":2785,"name":"Task","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Storage Task used for Uploading or Downloading files.","text":"#### Example 1\n\nGet a Upload Storage task to upload a string:\n\n```js\nconst string = '{ \"foo\": 1 }';\nconst task = firebase\n .storage()\n .ref('/foo/bar.json')\n .putString(string);\n```\n\n#### Example 2\n\nGet a Download Storage task to download a file:\n\n```js\nconst downloadTo = `${firebase.utils.FilePath.DOCUMENT_DIRECTORY}/bar.json`;\n\nconst task = firebase\n .storage()\n .ref('/foo/bar.json')\n .writeToFile(downloadTo);\n```\n"},"children":[{"id":2786,"name":"snapshot","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Initial state of Task.snapshot is `null`. Once uploading begins, it updates to a `TaskSnapshot` object."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":744,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"reference","name":"TaskSnapshot","id":2825}]}},{"id":2791,"name":"cancel","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2792,"name":"cancel","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Cancel the current Download or Upload task.","text":"#### Example\n\nCancel a task inside a state changed listener:\n\n```js\ntask.on('state_changed', taskSnapshot => {\n  console.log('Cancelling my task!');\n  task.cancel();\n});\n```\n\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"boolean"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":801,"character":10}]},{"id":2819,"name":"catch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2820,"name":"catch","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2821,"name":"onRejected","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":2822,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2823,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2824,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"NativeFirebaseError","id":2}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":848,"character":21}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"any"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":848,"character":9}]},{"id":2793,"name":"on","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2794,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Task event handler called when state has changed on the task.","text":"#### Example\n\n```js\nconst task = firebase\n .storage()\n .ref('/foo/bar.json')\n .writeToFile(downloadTo);\n\ntask.on('state_changed', (taskSnapshot) => {\n  console.log(taskSnapshot.state);\n});\n\ntask.then(() => {]\n  console.log('Task complete');\n})\n.catch((error) => {\n  console.error(error.message);\n});\n```\n"},"parameters":[{"id":2795,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The event name to handle, always `state_changed`."},"type":{"type":"stringLiteral","value":"state_changed"}},{"id":2796,"name":"nextOrObserver","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The optional event observer function."},"type":{"type":"union","types":[{"type":"reference","name":"TaskSnapshotObserver","id":2773},{"type":"intrinsic","name":"null"},{"type":"reflection","declaration":{"id":2797,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2798,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2799,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"TaskSnapshot","id":2825}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":833,"character":52}]}}]}},{"id":2800,"name":"error","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional JavaScript error handler."},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2801,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2802,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2803,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"NativeFirebaseError","id":2}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":834,"character":13}]}},{"type":"intrinsic","name":"null"}]}},{"id":2804,"name":"complete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional complete handler function.\n"},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2805,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2806,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":835,"character":16}]}},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reflection","declaration":{"id":2807,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2808,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":836,"character":6}]}}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":831,"character":6}]},{"id":2787,"name":"pause","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2788,"name":"pause","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Pause the current Download or Upload task.","text":"#### Example\n\nPause a running task inside a state changed listener:\n\n```js\ntask.on('state_changed', taskSnapshot => {\n  if (taskSnapshot.state === firebase.storage.TaskState.RUNNING) {\n    console.log('Pausing my task!');\n    task.pause();\n  }\n});\n```\n\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"boolean"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":763,"character":9}]},{"id":2789,"name":"resume","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2790,"name":"resume","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Resume the current Download or Upload task.","text":"#### Example\n\nResume a previously paused task inside a state changed listener:\n\n```js\ntask.on('state_changed', taskSnapshot => {\n  // ... pause me ...\n  if (taskSnapshot.state === firebase.storage.TaskState.PAUSED) {\n    console.log('Resuming my task!');\n    task.resume();\n  }\n});\n```\n\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"boolean"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":783,"character":10}]},{"id":2809,"name":"then","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2810,"name":"then","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2811,"name":"onFulfilled","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2812,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2813,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2814,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"TaskSnapshot","id":2825}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":844,"character":19}]}},{"type":"intrinsic","name":"null"}]}},{"id":2815,"name":"onRejected","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2816,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2817,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2818,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"NativeFirebaseError","id":2}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":845,"character":18}]}},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"any"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":843,"character":8}]}],"groups":[{"title":"Properties","kind":1024,"children":[2786]},{"title":"Methods","kind":2048,"children":[2791,2819,2793,2787,2789,2809]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":740,"character":23}]},{"id":2690,"name":"TaskEvent","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An event to subscribe to that is triggered on a Upload or Download task.","text":"Event subscription is created via `StorageTask.on()`.\n\n```js\nfirebase.storage.TaskEvent;\n```\n"},"children":[{"id":2691,"name":"STATE_CHANGED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An event that indicates that the tasks state has changed.","text":"```js\nfirebase.storage.TaskEvent.STATE_CHANGED;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":158,"character":17}],"type":{"type":"stringLiteral","value":"state_changed"}}],"groups":[{"title":"Properties","kind":1024,"children":[2691]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":150,"character":28}]},{"id":2825,"name":"TaskSnapshot","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A TaskSnapshot provides information about a storage tasks state.","text":"#### Example 1\n\n```js\nfirebase\n  .storage()\n  .ref('/foo/bar.json')\n  .putString(JSON.stringify({ foo: 'bar' }))\n  .then((taskSnapshot) => {\n    if (taskSnapshot.state === firebase.storage.TaskState.SUCCESS) {\n      console.log('Total bytes uploaded: ', taskSnapshot.totalBytes);\n    }\n  });\n```\n\n#### Example 2\n\n```js\nconst task = firebase\n  .storage()\n  .ref('/foo/bar.json')\n  .putString(JSON.stringify({ foo: 'bar' }));\n\ntask.on('state_changed', taskSnapshot => {\n  if (taskSnapshot.state === firebase.storage.TaskState.PAUSED) {\n    console.log('Resuming my task!');\n    task.resume();\n  }\n});\n```\n"},"children":[{"id":2826,"name":"bytesTransferred","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The number of bytes currently transferred."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":888,"character":20}],"type":{"type":"intrinsic","name":"number"}},{"id":2832,"name":"error","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If the {@link storage.TaskSnapshot#state} is `error`, returns a JavaScript error of the\ncurrent task snapshot."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":919,"character":9}],"type":{"type":"reference","name":"NativeFirebaseError","id":2}},{"id":2827,"name":"metadata","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The metadata of the tasks via a {@link storage.FullMetadata} interface."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":893,"character":12}],"type":{"type":"reference","name":"FullMetadata","id":2712}},{"id":2828,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The {@link storage.Reference} of the task."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":898,"character":7}],"type":{"type":"reference","name":"Reference","id":2731}},{"id":2829,"name":"state","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current state of the task snapshot."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":903,"character":9}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"cancelled"},{"type":"stringLiteral","value":"error"},{"type":"stringLiteral","value":"paused"},{"type":"stringLiteral","value":"running"},{"type":"stringLiteral","value":"success"}]}},{"id":2830,"name":"task","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The parent {@link storage.Task} of this snapshot."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":908,"character":8}],"type":{"type":"reference","name":"Task","id":2785}},{"id":2831,"name":"totalBytes","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The total amount of bytes for this task."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":913,"character":14}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[2826,2832,2827,2828,2829,2830,2831]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":884,"character":31}]},{"id":2773,"name":"TaskSnapshotObserver","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The snapshot observer returned from a {@link storage.Task#on} listener.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref(...);\nconst task = ref.put(...)\n\ntask.on('state_changed', {\n  next(taskSnapshot) {\n    console.log(taskSnapshot.state);\n  },\n  error(error) {\n    console.error(error.message);\n  },\n  complete() {\n    console.log('Task complete');\n  },\n})\n```\n"},"children":[{"id":2782,"name":"complete","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Called when the task has completed successfully."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":709,"character":12}],"type":{"type":"reflection","declaration":{"id":2783,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2784,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":709,"character":13}]}}},{"id":2778,"name":"error","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Called when the task errors."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":704,"character":9}],"type":{"type":"reflection","declaration":{"id":2779,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"comment":{"text":"A JavaScript error.\n"},"signatures":[{"id":2780,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"comment":{"text":"A JavaScript error.\n"},"parameters":[{"id":2781,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"NativeFirebaseError","id":2}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":704,"character":10}]}}},{"id":2774,"name":"next","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Called when the task state changes.","tags":[{"tag":"param","text":"A `TaskSnapshot` for the event.\n","param":"taskSnapshot"}]},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":697,"character":8}],"type":{"type":"reflection","declaration":{"id":2775,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2776,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2777,"name":"taskSnapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"TaskSnapshot","id":2825}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":697,"character":9}]}}}],"groups":[{"title":"Properties","kind":1024,"children":[2782,2778,2774]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":691,"character":39}]},{"id":2692,"name":"TaskState","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A collection of properties that indicates the current tasks state.","text":"An event subscription is created via `StorageTask.on()`.\n\n```js\nfirebase.storage.TaskEvent;\n```\n"},"children":[{"id":2693,"name":"CANCELLED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Task has been cancelled by the user."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":174,"character":13}],"type":{"type":"stringLiteral","value":"cancelled"}},{"id":2694,"name":"ERROR","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An Error occurred, see TaskSnapshot.error for details."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":179,"character":9}],"type":{"type":"stringLiteral","value":"error"}},{"id":2695,"name":"PAUSED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Task has been paused. Resume the task via `StorageTask.resume()`."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":184,"character":10}],"type":{"type":"stringLiteral","value":"paused"}},{"id":2696,"name":"RUNNING","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Task is running. Pause the task via `StorageTask.pause()`"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":189,"character":11}],"type":{"type":"stringLiteral","value":"running"}},{"id":2697,"name":"SUCCESS","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Task has completed successfully."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":194,"character":11}],"type":{"type":"stringLiteral","value":"success"}}],"groups":[{"title":"Properties","kind":1024,"children":[2693,2694,2695,2696,2697]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":170,"character":28}]}],"groups":[{"title":"Classes","kind":128,"children":[2840]},{"title":"Interfaces","kind":256,"children":[2712,2833,2836,2731,2702,2698,2685,2785,2690,2825,2773,2692]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":56,"character":37}]},{"id":2286,"name":"FirebaseVisionTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase ML Kit package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `ml-vision` package:\n\n```js\nimport { firebase } from '@react-native-firebase/ml-vision';\n\n// firebase.vision().X\n```\n\n#### Example 2\n\nUsing the default export from the `ml-vision` package:\n\n```js\nimport vision from '@react-native-firebase/ml-vision';\n\n// vision().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/ml-vision';\n\n// firebase.vision().X\n```\n","tags":[{"tag":"firebase","text":"ml-vision\n"}]},"children":[{"id":2320,"name":"VisionCloudLandmarkRecognizerModelType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Model types for cloud landmark recognition."},"children":[{"id":2322,"name":"LATEST_MODEL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Latest model would be used."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":304,"character":16}],"defaultValue":"2"},{"id":2321,"name":"STABLE_MODEL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Stable model would be used."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":299,"character":16}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2322,2321]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":295,"character":52}]},{"id":2332,"name":"VisionCloudTextRecognizerModelType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The cloud model type used for in VisionCloudTextRecognizerOptions & VisionCloudDocumentTextRecognizerOptions","text":"Defaults to `SPARSE_MODEL`\n"},"children":[{"id":2334,"name":"DENSE_MODEL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Sparse model type. It is more suitable for sparse text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":450,"character":15}],"defaultValue":"2"},{"id":2333,"name":"SPARSE_MODEL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Dense model type. It is more suitable for well-formatted dense text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":446,"character":16}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2334,2333]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":442,"character":48}]},{"id":2377,"name":"VisionDocumentTextRecognizedBreakType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Enum representing the detected break type."},"children":[{"id":2378,"name":"EOL_SURE_SPACE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Line-wrapping break."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":597,"character":18}],"defaultValue":"3"},{"id":2379,"name":"HYPHEN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":602,"character":10}],"defaultValue":"4"},{"id":2380,"name":"LINE_BREAK","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Line break that ends a paragraph."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":607,"character":14}],"defaultValue":"5"},{"id":2381,"name":"SPACE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Regular space."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":612,"character":9}],"defaultValue":"1"},{"id":2382,"name":"SURE_SPACE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Sure space (very wide)."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":617,"character":14}],"defaultValue":"2"},{"id":2383,"name":"UNKNOWN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Unknown break label type."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":622,"character":11}],"defaultValue":"0"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2378,2379,2380,2381,2382,2383]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":593,"character":51}]},{"id":2452,"name":"VisionFaceContourType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Countour type for a face."},"children":[{"id":2453,"name":"ALL_POINTS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"All points of a face contour."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":920,"character":14}],"defaultValue":"1"},{"id":2454,"name":"FACE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The outline of the subject's face."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":925,"character":8}],"defaultValue":"2"},{"id":2455,"name":"LEFT_EYE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The outline of the subject's left eye cavity."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":930,"character":12}],"defaultValue":"7"},{"id":2456,"name":"LEFT_EYEBROW_BOTTOM","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The bottom outline of the subject's left eyebrow."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":935,"character":23}],"defaultValue":"4"},{"id":2457,"name":"LEFT_EYEBROW_TOP","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The top outline of the subject's left eyebrow."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":940,"character":20}],"defaultValue":"3"},{"id":2458,"name":"LOWER_LIP_BOTTOM","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The bottom outline of the subject's lower lip."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":945,"character":20}],"defaultValue":"12"},{"id":2459,"name":"LOWER_LIP_TOP","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The top outline of the subject's lower lip."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":950,"character":17}],"defaultValue":"11"},{"id":2460,"name":"NOSE_BOTTOM","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The outline of the subject's nose bridge."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":955,"character":15}],"defaultValue":"14"},{"id":2461,"name":"NOSE_BRIDGE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The outline of the subject's nose bridge."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":960,"character":15}],"defaultValue":"13"},{"id":2462,"name":"RIGHT_EYE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The outline of the subject's right eye cavity."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":965,"character":13}],"defaultValue":"8"},{"id":2463,"name":"RIGHT_EYEBROW_BOTTOM","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The bottom outline of the subject's right eyebrow."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":970,"character":24}],"defaultValue":"6"},{"id":2464,"name":"RIGHT_EYEBROW_TOP","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The top outline of the subject's right eyebrow."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":975,"character":21}],"defaultValue":"5"},{"id":2465,"name":"UPPER_LIP_BOTTOM","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The bottom outline of the subject's upper lip."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":980,"character":20}],"defaultValue":"10"},{"id":2466,"name":"UPPER_LIP_TOP","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The top outline of the subject's upper lip."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":985,"character":17}],"defaultValue":"9"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2453,2454,2455,2456,2457,2458,2459,2460,2461,2462,2463,2464,2465,2466]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":916,"character":35}]},{"id":2335,"name":"VisionFaceDetectorClassificationMode","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Indicates whether to run additional classifiers for characterizing attributes such as \"smiling\" and \"eyes open\"."},"children":[{"id":2337,"name":"ALL_CLASSIFICATIONS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Enables collection of classifier information."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":465,"character":23}],"defaultValue":"2"},{"id":2336,"name":"NO_CLASSIFICATIONS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Disables collection of classifier information."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":460,"character":22}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2337,2336]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":456,"character":50}]},{"id":2338,"name":"VisionFaceDetectorContourMode","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Sets whether to detect contours or not. Processing time increases as the number of contours to search for increases,\nso detecting all contours will increase the overall detection time."},"children":[{"id":2340,"name":"ALL_CONTOURS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Enables collection of contour information."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":481,"character":16}],"defaultValue":"2"},{"id":2339,"name":"NO_CONTOURS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Disables collection of contour information."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":476,"character":15}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2340,2339]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":472,"character":43}]},{"id":2341,"name":"VisionFaceDetectorLandmarkMode","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Sets whether to detect no landmarks or all landmarks. Processing time increases as the number of landmarks to\nsearch for increases, so detecting all landmarks will increase the overall detection time. Detecting\nlandmarks can improve pose estimation."},"children":[{"id":2343,"name":"ALL_LANDMARKS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Enables collection of landmark information."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":498,"character":17}],"defaultValue":"2"},{"id":2342,"name":"NO_LANDMARKS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Disables collection of landmark information."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":493,"character":16}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2343,2342]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":489,"character":44}]},{"id":2344,"name":"VisionFaceDetectorPerformanceMode","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Extended option for controlling additional accuracy / speed trade-offs in performing face detection. In general,\nchoosing the more accurate mode will generally result in longer runtime, whereas choosing the faster\nmode will generally result in detecting fewer faces."},"children":[{"id":2346,"name":"ACCURATE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Indicates a preference for accuracy in extended settings that may make an accuracy vs. speed trade-off.\nThis will tend to detect more faces and may be more precise in determining values such as position, at the cost\nof speed."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":518,"character":12}],"defaultValue":"2"},{"id":2345,"name":"FAST","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Indicates a preference for speed in extended settings that may make an accuracy vs. speed trade-off. This will\ntend to detect fewer faces and may be less precise in determining values such as position, but will run faster."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":511,"character":8}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2346,2345]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":506,"character":47}]},{"id":2438,"name":"VisionFaceLandmarkType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Landmark types for a face."},"children":[{"id":2439,"name":"LEFT_CHEEK","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The midpoint between the subject's left mouth corner and the outer corner of the subject's left eye."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":847,"character":14}],"defaultValue":"1"},{"id":2440,"name":"LEFT_EAR","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The midpoint of the subject's left ear tip and left ear lobe."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":852,"character":12}],"defaultValue":"3"},{"id":2441,"name":"LEFT_EYE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The center of the subject's left eye cavity."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":857,"character":12}],"defaultValue":"4"},{"id":2442,"name":"MOUTH_BOTTOM","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The center of the subject's bottom lip."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":862,"character":16}],"defaultValue":"0"},{"id":2443,"name":"MOUTH_LEFT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The subject's left mouth corner where the lips meet."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":867,"character":14}],"defaultValue":"5"},{"id":2444,"name":"MOUTH_RIGHT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The subject's right mouth corner where the lips meet."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":872,"character":15}],"defaultValue":"11"},{"id":2445,"name":"NOSE_BASE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The midpoint between the subject's nostrils where the nose meets the face."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":877,"character":13}],"defaultValue":"6"},{"id":2446,"name":"RIGHT_CHEEK","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The midpoint between the subject's right mouth corner and the outer corner of the subject's right eye."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":882,"character":15}],"defaultValue":"7"},{"id":2447,"name":"RIGHT_EAR","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The midpoint of the subject's right ear tip and right ear lobe."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":887,"character":13}],"defaultValue":"9"},{"id":2448,"name":"RIGHT_EYE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The center of the subject's right eye cavity."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":892,"character":13}],"defaultValue":"10"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2439,2440,2441,2442,2443,2444,2445,2446,2447,2448]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":843,"character":36}]},{"id":2473,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase ML Kit service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the ML Kit service for the default app:\n\n```js\nconst defaultAppMLKit = firebase.vision();\n```\n"},"children":[{"id":2505,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":2501,"name":"barcodeDetectorProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2502,"name":"barcodeDetectorProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an array of barcodes (as `VisionBarcode`) detected for a local image file path.","text":"Barcode detection is done locally on device.\n\n#### Example 1\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo);\n}\n```\n\n#### Example 2\n\nProcess image with custom `VisionBarcodeDetectorOptions`.\n\n```js\nimport vision, { VisionBarcodeFormat, VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath, {\n  barcodeFormats: [VisionBarcodeFormat.QR_CODE]\n});\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo);\n}\n```\n"},"parameters":[{"id":2503,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local image file path."},"type":{"type":"intrinsic","name":"string"}},{"id":2504,"name":"barcodeDetectorOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional instance of `VisionBarcodeDetectorOptions`.\n"},"type":{"type":"reference","name":"VisionBarcodeDetectorOptions","id":2236}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"VisionBarcode","id":2161}}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1171,"character":31}]},{"id":2485,"name":"cloudDocumentTextRecognizerProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2486,"name":"cloudDocumentTextRecognizerProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detect text within a document using a local image file from the cloud (Firebase) model."},"parameters":[{"id":2487,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local path to an image on the device."},"type":{"type":"intrinsic","name":"string"}},{"id":2488,"name":"cloudDocumentTextRecognizerOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An instance of `VisionCloudDocumentTextRecognizerOptions`.\n"},"type":{"type":"reference","name":"VisionCloudDocumentTextRecognizerOptions","id":2328}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"VisionDocumentText","id":2393}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1078,"character":43}]},{"id":2497,"name":"cloudImageLabelerProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2498,"name":"cloudImageLabelerProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an array of labels (as `VisionImageLabel`) of a given local image file path. Label detection is done\non cloud (Firebase), resulting in slower results but more descriptive.","text":"#### Example\n\n```js\nconst labels = await firebase.vision().cloudImageLabelerProcessImage(filePath, {\n  confidenceThreshold: 0.8,\n});\n```\n"},"parameters":[{"id":2499,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local image file path."},"type":{"type":"intrinsic","name":"string"}},{"id":2500,"name":"cloudImageLabelerOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional instance of `VisionCloudImageLabelerOptions`.\n"},"type":{"type":"reference","name":"VisionCloudImageLabelerOptions","id":2311}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"VisionImageLabel","id":2422}}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1130,"character":33}]},{"id":2489,"name":"cloudLandmarkRecognizerProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2490,"name":"cloudLandmarkRecognizerProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an array of landmarks (as `VisionLandmark`) of a given local image file path. Landmark detection\nis done on cloud (Firebase)."},"parameters":[{"id":2491,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local image file path."},"type":{"type":"intrinsic","name":"string"}},{"id":2492,"name":"cloudLandmarkRecognizerOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional instance of `VisionCloudLandmarkRecognizerOptions`.\n"},"type":{"type":"reference","name":"VisionCloudLandmarkRecognizerOptions","id":2315}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"VisionLandmark","id":2467}}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1090,"character":39}]},{"id":2481,"name":"cloudTextRecognizerProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2482,"name":"cloudTextRecognizerProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detect text from a local image file using the cloud (Firebase) model."},"parameters":[{"id":2483,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local path to an image on the device."},"type":{"type":"intrinsic","name":"string"}},{"id":2484,"name":"cloudTextRecognizerOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An instance of `VisionCloudTextRecognizerOptions`.\n"},"type":{"type":"reference","name":"VisionCloudTextRecognizerOptions","id":2323}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"VisionText","id":2347}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1067,"character":35}]},{"id":2474,"name":"faceDetectorProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2475,"name":"faceDetectorProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detects faces from a local image file."},"parameters":[{"id":2476,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local path to an image on the device."},"type":{"type":"intrinsic","name":"string"}},{"id":2477,"name":"faceDetectorOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional instance of `VisionFaceDetectorOptions`.\n"},"type":{"type":"reference","name":"VisionFaceDetectorOptions","id":2303}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"VisionFace","id":2426}}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1049,"character":28}]},{"id":2493,"name":"imageLabelerProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2494,"name":"imageLabelerProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an array of labels (as `VisionImageLabel`) of a given local image file path. Label detection is done\non device, resulting in faster results but less descriptive.","text":"#### Example\n\n```js\nconst labels = await firebase.vision().imageLabelerProcessImage(filePath, {\n  confidenceThreshold: 0.8,\n});\n```\n"},"parameters":[{"id":2495,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local image file path."},"type":{"type":"intrinsic","name":"string"}},{"id":2496,"name":"imageLabelerOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional instance of `VisionImageLabelerOptions`.\n"},"type":{"type":"reference","name":"VisionImageLabelerOptions","id":2309}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"VisionImageLabel","id":2422}}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1110,"character":28}]},{"id":2478,"name":"textRecognizerProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2479,"name":"textRecognizerProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detect text from a local image file using the on-device model."},"parameters":[{"id":2480,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local path to an image on the device.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"VisionText","id":2347}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1059,"character":30}]}],"groups":[{"title":"Properties","kind":1024,"children":[2505]},{"title":"Methods","kind":2048,"children":[2501,2485,2497,2489,2481,2474,2493,2478]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1042,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":2287,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":2299,"name":"VisionBarcodeAddressType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":71,"character":28}],"type":{"type":"intrinsic","name":"any"}},{"id":2300,"name":"VisionBarcodeEmailType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":72,"character":26}],"type":{"type":"intrinsic","name":"any"}},{"id":2297,"name":"VisionBarcodeFormat","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":69,"character":23}],"type":{"type":"intrinsic","name":"any"}},{"id":2301,"name":"VisionBarcodePhoneType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":73,"character":26}],"type":{"type":"intrinsic","name":"any"}},{"id":2298,"name":"VisionBarcodeValueType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":70,"character":26}],"type":{"type":"intrinsic","name":"any"}},{"id":2302,"name":"VisionBarcodeWifiEncryptionType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":74,"character":35}],"type":{"type":"intrinsic","name":"any"}},{"id":2295,"name":"VisionCloudLandmarkRecognizerModelType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":67,"character":42}],"type":{"type":"reference","name":"VisionCloudLandmarkRecognizerModelType","id":2320}},{"id":2288,"name":"VisionCloudTextRecognizerModelType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":60,"character":38}],"type":{"type":"reference","name":"VisionCloudTextRecognizerModelType","id":2332}},{"id":2296,"name":"VisionDocumentTextRecognizedBreakType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":68,"character":41}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreakType","id":2377}},{"id":2294,"name":"VisionFaceContourType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":66,"character":25}],"type":{"type":"reference","name":"VisionFaceContourType","id":2452}},{"id":2289,"name":"VisionFaceDetectorClassificationMode","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":61,"character":40}],"type":{"type":"reference","name":"VisionFaceDetectorClassificationMode","id":2335}},{"id":2290,"name":"VisionFaceDetectorContourMode","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":62,"character":33}],"type":{"type":"reference","name":"VisionFaceDetectorContourMode","id":2338}},{"id":2291,"name":"VisionFaceDetectorLandmarkMode","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":63,"character":34}],"type":{"type":"reference","name":"VisionFaceDetectorLandmarkMode","id":2341}},{"id":2292,"name":"VisionFaceDetectorPerformanceMode","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":64,"character":37}],"type":{"type":"reference","name":"VisionFaceDetectorPerformanceMode","id":2344}},{"id":2293,"name":"VisionFaceLandmarkType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":65,"character":26}],"type":{"type":"reference","name":"VisionFaceLandmarkType","id":2438}}],"groups":[{"title":"Properties","kind":1024,"children":[2299,2300,2297,2301,2298,2302,2295,2288,2296,2294,2289,2290,2291,2292,2293]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":59,"character":26}]},{"id":2328,"name":"VisionCloudDocumentTextRecognizerOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Options for the cloud document text recognizer."},"children":[{"id":2331,"name":"apiKeyOverride","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"API key to use for Cloud Vision API. If not set, the default API key from `firebase.app()` will be used.","text":"#### Example\n\n```js\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  apiKeyOverride: 'xyz123',\n});\n```\n","tags":[{"tag":"ios","text":"\n"}]},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":434,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2329,"name":"enforceCertFingerprintMatch","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Only allow registered application instances with matching certificate fingerprint to use Cloud Vision API.","text":"> Do not set this for debug build if you use simulators to test.\n\n#### Example\n\n```js\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  enforceCertFingerprintMatch: true,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":401,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2330,"name":"languageHints","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets language hints. In most cases, not setting this yields the best results since it enables automatic language\ndetection. For languages based on the Latin alphabet, setting language hints is not needed. In rare cases, when\nthe language of the text in the image is known, setting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong).","text":"Each language code must be a BCP-47 identifier. See [Google Cloud OCR Language Support](https://cloud.google.com/vision/docs/languages) for more information.\n\n#### Example\n\n```js\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  languageHints: ['fr', 'de'],\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":419,"character":17}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"groups":[{"title":"Properties","kind":1024,"children":[2331,2329,2330]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":387,"character":59}]},{"id":2311,"name":"VisionCloudImageLabelerOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Options for cloud image labeler. Confidence threshold could be provided for the label detection.","text":"For example, if the confidence threshold is set to 0.7, only labels with confidence >= 0.7 would be returned. The default threshold is 0.5.\n\nNote: at most 20 labels will be returned for cloud image labeler.\n"},"children":[{"id":2314,"name":"apiKeyOverride","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"API key to use for Cloud Vision API. If not set, the default API key from `firebase.app()` will be used.","text":"#### Example\n\n```js\nawait firebase.vision().cloudImageLabelerProcessImage(filePath, {\n  apiKeyOverride: 'xyz123',\n});\n```\n","tags":[{"tag":"ios","text":"\n"}]},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":254,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2313,"name":"confidenceThreshold","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets confidence threshold in the range of [0.0 - 1.0] of detected labels. Only labels detected with confidence higher than this threshold are returned.","text":"Defaults to 0.5.\n\n#### Example\n\n```js\nawait firebase.vision().cloudImageLabelerProcessImage(filePath, {\n  confidenceThreshold: 0.8,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":239,"character":23}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":2312,"name":"enforceCertFingerprintMatch","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Only allow registered application instances with matching certificate fingerprint to use Cloud Vision API.","text":"> Do not set this for debug build if you use simulators to test.\n\n#### Example\n\n```js\nawait firebase.vision().cloudImageLabelerProcessImage(filePath, {\n  enforceCertFingerprintMatch: true,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":224,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2314,2313,2312]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":210,"character":49}]},{"id":2315,"name":"VisionCloudLandmarkRecognizerOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Detector for finding popular natural and man-made structures within an image."},"children":[{"id":2319,"name":"apiKeyOverride","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"API key to use for Cloud Vision API. If not set, the default API key from `firebase.app()` will be used.","tags":[{"tag":"ios","text":"\n"}]},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":289,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2316,"name":"enforceCertFingerprintMatch","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Only allow registered application instances with matching certificate fingerprint to use Cloud Vision API.","text":"> Do not set this for debug build if you use simulators to test.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":266,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2317,"name":"maxResults","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the maximum number of results of this type.","text":"Defaults to 10.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":273,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":2318,"name":"modelType","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets model type for the detection.","text":"Defaults to `VisionCloudLandmarkRecognizerModelType.STABLE_MODEL`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":280,"character":13}],"type":{"type":"union","types":[{"type":"reference","name":"STABLE_MODEL","id":2321},{"type":"reference","name":"LATEST_MODEL","id":2322}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2319,2316,2317,2318]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":260,"character":55}]},{"id":2323,"name":"VisionCloudTextRecognizerOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Options for cloud text recognizer."},"children":[{"id":2327,"name":"apiKeyOverride","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"API key to use for Cloud Vision API. If not set, the default API key from `firebase.app()` will be used.","text":"#### Example\n\n```js\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  apiKeyOverride: 'xyz123',\n});\n```\n","tags":[{"tag":"ios","text":"\n"}]},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":381,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2324,"name":"enforceCertFingerprintMatch","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Only allow registered application instances with matching certificate fingerprint to use Cloud Vision API.","text":"> Do not set this for debug build if you use simulators to test.\n\n#### Example\n\n```js\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  enforceCertFingerprintMatch: true,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":324,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2326,"name":"languageHints","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets language hints. In most cases, not setting this yields the best results since it enables automatic language\ndetection. For languages based on the Latin alphabet, setting language hints is not needed. In rare cases, when\nthe language of the text in the image is known, setting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong).","text":"Each language code must be a BCP-47 identifier. See [Google Cloud OCR Language Support](https://cloud.google.com/vision/docs/languages) for more information.\n\n#### Example\n\n```js\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  languageHints: ['fr', 'de'],\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":366,"character":17}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2325,"name":"modelType","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets model type for cloud text recognition. The two models SPARSE_MODEL and DENSE_MODEL handle different text densities in an image.","text":"See `VisionCloudTextRecognizerModelType` for types.\n\nDefaults to `VisionCloudTextRecognizerModelType.SPARSE_MODEL`.\n\n#### Example\n\n```js\nimport {\n  firebase,\n  VisionCloudTextRecognizerModelType,\n} from '@react-native-firebase/ml-vision';\n\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  modelType: VisionCloudTextRecognizerModelType.DENSE_MODEL,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":346,"character":13}],"type":{"type":"union","types":[{"type":"reference","name":"SPARSE_MODEL","id":2333},{"type":"reference","name":"DENSE_MODEL","id":2334}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2327,2324,2326,2325]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":310,"character":51}]},{"id":2393,"name":"VisionDocumentText","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A hierarchical representation of document text recognized in an image."},"children":[{"id":2394,"name":"blocks","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an array `VisionTextBlock`, which is a block of text that can be further decomposed to an array of `VisionDocumentTextParagraph`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":678,"character":10}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionDocumentTextBlock","id":2350}},"overwrites":{"type":"reference","name":"VisionText.blocks","id":2349}},{"id":2395,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Retrieve the recognized text as a string."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":544,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionText.text","id":2348}}],"groups":[{"title":"Properties","kind":1024,"children":[2394,2395]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":674,"character":37}],"extendedTypes":[{"type":"reference","name":"VisionText","id":2347}]},{"id":2387,"name":"VisionDocumentTextBase","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A shared type that all VisionDocumentText components inherit from"},"children":[{"id":2391,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":663,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506}},{"id":2389,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":651,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]}},{"id":2392,"name":"recognizedBreak","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized break - the detected start or end of a structural component."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":668,"character":19}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreak","id":2384}},{"id":2390,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":658,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}}},{"id":2388,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":646,"character":8}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2391,2389,2392,2390,2388]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":642,"character":41}],"extendedBy":[{"type":"reference","name":"VisionDocumentTextBlock","id":2350},{"type":"reference","name":"VisionDocumentTextParagraph","id":2357},{"type":"reference","name":"VisionDocumentTextWord","id":2364},{"type":"reference","name":"VisionDocumentTextSymbol","id":2371}]},{"id":2350,"name":"VisionDocumentTextBlock","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a block of text."},"children":[{"id":2355,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":663,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.boundingBox","id":2391}},{"id":2353,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":651,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.confidence","id":2389}},{"id":2351,"name":"paragraphs","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an Array of `VisionDocumentTextParagraph`s that make up this block."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":559,"character":14}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionDocumentTextParagraph","id":2357}}},{"id":2356,"name":"recognizedBreak","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized break - the detected start or end of a structural component."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":668,"character":19}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreak","id":2384},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedBreak","id":2392}},{"id":2354,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":658,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedLanguages","id":2390}},{"id":2352,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":646,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.text","id":2388}}],"groups":[{"title":"Properties","kind":1024,"children":[2355,2353,2351,2356,2354,2352]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":555,"character":42}],"extendedTypes":[{"type":"reference","name":"VisionDocumentTextBase","id":2387}]},{"id":2357,"name":"VisionDocumentTextParagraph","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A structural unit of text representing a number of words in certain order."},"children":[{"id":2362,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":663,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.boundingBox","id":2391}},{"id":2360,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":651,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.confidence","id":2389}},{"id":2363,"name":"recognizedBreak","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized break - the detected start or end of a structural component."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":668,"character":19}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreak","id":2384},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedBreak","id":2392}},{"id":2361,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":658,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedLanguages","id":2390}},{"id":2359,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":646,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.text","id":2388}},{"id":2358,"name":"words","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an Array of `VisionDocumentTextWord`s that make up this paragraph.","text":"Returns an empty list if no Word is found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":571,"character":9}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionDocumentTextWord","id":2364}}}],"groups":[{"title":"Properties","kind":1024,"children":[2362,2360,2363,2361,2359,2358]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":565,"character":46}],"extendedTypes":[{"type":"reference","name":"VisionDocumentTextBase","id":2387}]},{"id":2384,"name":"VisionDocumentTextRecognizedBreak","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A recognized break is the detected start or end of a structural component."},"children":[{"id":2385,"name":"breakType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets detected break type."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":632,"character":13}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreakType","id":2377}},{"id":2386,"name":"isPrefix","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns true if break prepends an element."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":637,"character":12}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[2385,2386]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":628,"character":52}]},{"id":2371,"name":"VisionDocumentTextSymbol","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A single symbol representation."},"children":[{"id":2375,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":663,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.boundingBox","id":2391}},{"id":2373,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":651,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.confidence","id":2389}},{"id":2376,"name":"recognizedBreak","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized break - the detected start or end of a structural component."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":668,"character":19}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreak","id":2384},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedBreak","id":2392}},{"id":2374,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":658,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedLanguages","id":2390}},{"id":2372,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":646,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.text","id":2388}}],"groups":[{"title":"Properties","kind":1024,"children":[2375,2373,2376,2374,2372]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":588,"character":43}],"extendedTypes":[{"type":"reference","name":"VisionDocumentTextBase","id":2387}]},{"id":2364,"name":"VisionDocumentTextWord","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A single word representation."},"children":[{"id":2369,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":663,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.boundingBox","id":2391}},{"id":2367,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":651,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.confidence","id":2389}},{"id":2370,"name":"recognizedBreak","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized break - the detected start or end of a structural component."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":668,"character":19}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreak","id":2384},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedBreak","id":2392}},{"id":2368,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":658,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedLanguages","id":2390}},{"id":2365,"name":"symbols","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an Array of `VisionDocumentTextSymbol`s that make up this word.\nThe order of the symbols follows the natural reading order."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":582,"character":11}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionDocumentTextSymbol","id":2371}}},{"id":2366,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":646,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.text","id":2388}}],"groups":[{"title":"Properties","kind":1024,"children":[2369,2367,2370,2368,2365,2366]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":577,"character":41}],"extendedTypes":[{"type":"reference","name":"VisionDocumentTextBase","id":2387}]},{"id":2426,"name":"VisionFace","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a face returned from `faceDetectorProcessImage()`."},"children":[{"id":2427,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the axis-aligned bounding rectangle of the detected face."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":771,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506}},{"id":2428,"name":"faceContours","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Represent a face contour. A contour is a list of points on a detected face, such as the mouth.","text":"When 'left' and 'right' are used, they are relative to the subject in the image. For example, the `LEFT_EYE`\nlandmark is the subject's left eye, not the eye that is on the left when viewing the image.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":779,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionFaceContour","id":2449}}},{"id":2429,"name":"headEulerAngleY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the rotation of the face about the vertical axis of the image. Positive euler y is when the face turns\ntoward the right side of the of the image that is being processed."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":785,"character":19}],"type":{"type":"intrinsic","name":"number"}},{"id":2430,"name":"headEulerAngleZ","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the rotation of the face about the axis pointing out of the image. Positive euler z is a\ncounter-clockwise rotation within the image plane."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":791,"character":19}],"type":{"type":"intrinsic","name":"number"}},{"id":2431,"name":"landmarks","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an array of `VisionFaceLandmark`.","text":"Returns an empty array if the landmark mode has not been enabled via `setLandmarkMode()`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":798,"character":13}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionFaceLandmark","id":2435}}},{"id":2432,"name":"leftEyeOpenProbability","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a value between 0.0 and 1.0 giving a probability that the face's left eye is open.","text":"Returns -1 if the classification mode has not been enabled via `setClassificationMode()`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":805,"character":26}],"type":{"type":"intrinsic","name":"number"}},{"id":2433,"name":"rightEyeOpenProbability","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a value between 0.0 and 1.0 giving a probability that the face's right eye is open.","text":"Returns -1 if the classification mode has not been enabled via `setClassificationMode()`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":812,"character":27}],"type":{"type":"intrinsic","name":"number"}},{"id":2434,"name":"smilingProbability","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a value between 0.0 and 1.0 giving a probability that the face is smiling.","text":"Returns -1 if the classification mode has not been enabled via `setClassificationMode()`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":819,"character":22}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[2427,2428,2429,2430,2431,2432,2433,2434]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":767,"character":29}]},{"id":2449,"name":"VisionFaceContour","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represent a face contour. A contour is a list of points on a detected face, such as the mouth.\nWhen 'left' and 'right' are used, they are relative to the subject in the image. For example, the `LEFT_EYE` landmark\nis the subject's left eye, not the eye that is on the left when viewing the image."},"children":[{"id":2451,"name":"points","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of 2D points for this face contour, where (0, 0) is the upper-left corner of the image. The point is\nguaranteed to be within the bounds of the image."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":910,"character":10}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}}},{"id":2450,"name":"type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the contour type."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":904,"character":8}],"type":{"type":"reference","name":"VisionFaceContourType","id":2452}}],"groups":[{"title":"Properties","kind":1024,"children":[2451,2450]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":900,"character":36}]},{"id":2303,"name":"VisionFaceDetectorOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Options for vision face detector."},"children":[{"id":2304,"name":"classificationMode","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Indicates whether to run additional classifiers for characterizing attributes such as \"smiling\" and \"eyes open\".","text":"Defaults to `VisionFaceDetectorClassificationMode.NO_CLASSIFICATIONS`.\n\n#### Example\n\n```js\nconst faces = await firebase.vision().faceDetectorProcessImage(filePath, {\n  classificationMode: VisionFaceDetectorClassificationMode.ALL_CLASSIFICATIONS,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":94,"character":22}],"type":{"type":"union","types":[{"type":"reference","name":"NO_CLASSIFICATIONS","id":2336},{"type":"reference","name":"ALL_CLASSIFICATIONS","id":2337}]}},{"id":2305,"name":"contourMode","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets whether to detect no contours or all contours. Processing time increases as the number of contours to search\nfor increases, so detecting all contours will increase the overall detection time. Note that it would return up\nto 5 faces contours.","text":"Defaults to `VisionFaceDetectorContourMode.NO_CONTOURS`.\n\n#### Example\n\n```js\nconst faces = await firebase.vision().faceDetectorProcessImage(filePath, {\n  contourMode: VisionFaceDetectorContourMode.ALL_CONTOURS,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":113,"character":15}],"type":{"type":"union","types":[{"type":"reference","name":"NO_CONTOURS","id":2339},{"type":"reference","name":"ALL_CONTOURS","id":2340}]}},{"id":2306,"name":"landmarkMode","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets whether to detect no landmarks or all landmarks. Processing time increases as the number of landmarks to\nsearch for increases, so detecting all landmarks will increase the overall detection time. Detecting landmarks\ncan improve pose estimation.","text":"Defaults to `VisionFaceDetectorLandmarkMode.NO_LANDMARKS`.\n\n#### Example\n\n```js\nconst faces = await firebase.vision().faceDetectorProcessImage(filePath, {\n  landmarkMode: VisionFaceDetectorLandmarkMode.ALL_LANDMARKS,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":132,"character":16}],"type":{"type":"union","types":[{"type":"reference","name":"NO_LANDMARKS","id":2342},{"type":"reference","name":"ALL_LANDMARKS","id":2343}]}},{"id":2307,"name":"minFaceSize","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the smallest desired face size, expressed as a proportion of the width of the head to the image width. For\nexample, if a value of 0.1 is specified then the smallest face to search for is roughly 10% of the width of the\nimage being searched.","text":"Setting the min face size is a performance vs. accuracy trade-off: setting the face size smaller will enable the\ndetector to find smaller faces but detection will take longer; setting the face size larger will exclude smaller\nfaces but will run faster.\n\nThis is not a hard limit on face size; the detector may find faces slightly smaller than specified.\n\nDefaults to 0.1.\n\n#### Example\n\n```js\nconst faces = await firebase.vision().faceDetectorProcessImage(filePath, {\n  minFaceSize: 0.5,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":157,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":2308,"name":"performanceMode","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Extended option for controlling additional accuracy / speed trade-offs in performing face detection. In general,\nchoosing the more accurate mode will generally result in longer runtime, whereas choosing the faster mode will\ngenerally result in detecting fewer faces.","text":"Defaults to `VisionFaceDetectorPerformanceMode.FAST`.\n\n#### Example\n\n```js\nconst faces = await firebase.vision().faceDetectorProcessImage(filePath, {\n  performanceMode: VisionFaceDetectorPerformanceMode.ACCURATE,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":174,"character":19}],"type":{"type":"union","types":[{"type":"reference","name":"FAST","id":2345},{"type":"reference","name":"ACCURATE","id":2346}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2304,2305,2306,2307,2308]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":80,"character":44}]},{"id":2435,"name":"VisionFaceLandmark","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represent a face landmark. A landmark is a point on a detected face, such as an eye, nose, or mouth.","text":"When 'left' and 'right' are used, they are relative to the subject in the image.  For example, the `LEFT_EYE` landmark\nis the subject's left eye, not the eye that is on the left when viewing the image.\n"},"children":[{"id":2437,"name":"position","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a 2D point for landmark position, where (0, 0) is the upper-left corner of the image."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":837,"character":12}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}}},{"id":2436,"name":"type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the landmark type."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":832,"character":8}],"type":{"type":"reference","name":"VisionFaceLandmarkType","id":2438}}],"groups":[{"title":"Properties","kind":1024,"children":[2437,2436]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":828,"character":37}]},{"id":2422,"name":"VisionImageLabel","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents an image label return from `imageLabelerProcessImage()` and `cloudImageLabelerProcessImage()`."},"children":[{"id":2425,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets overall confidence of the result.","text":"Range between 0 (low confidence) and 1 (high confidence).\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":761,"character":14}],"type":{"type":"intrinsic","name":"number"}},{"id":2424,"name":"entityId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an opaque entity ID. IDs are available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":754,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":2423,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a detected label from the given image. The label returned here is in English only.","text":"Use `entityId` to retrieve a unique id.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":749,"character":8}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2425,2424,2423]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":743,"character":35}]},{"id":2309,"name":"VisionImageLabelerOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Options for on device image labeler. Confidence threshold could be provided for the label detection."},"children":[{"id":2310,"name":"confidenceThreshold","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets confidence threshold of detected labels. Only labels detected with confidence higher than this threshold are returned.","text":"For example, if the confidence threshold is set to 0.7, only labels with confidence >= 0.7 would be returned.\n\nDefaults to 0.5.\n\n#### Example\n\n```js\nconst labels = await firebase.vision().imageLabelerProcessImage(filePath, {\n  confidenceThreshold: 0.8,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":200,"character":23}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2310]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":184,"character":44}]},{"id":2467,"name":"VisionLandmark","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a detected landmark returned from `cloudLandmarkRecognizerProcessImage()`."},"children":[{"id":2468,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets image region of the detected landmark. Returns null if nothing was detected"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":995,"character":15}],"type":{"type":"union","types":[{"type":"reference","name":"VisionRectangle","id":2506},{"type":"intrinsic","name":"null"}]}},{"id":2469,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets overall confidence of the result. Ranging between 0 & 1."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1000,"character":14}],"type":{"type":"intrinsic","name":"number"}},{"id":2470,"name":"entityId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1005,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":2471,"name":"landmark","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the detected landmark."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1010,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":2472,"name":"locations","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the location information for the detected entity.","text":"Multiple VisionGeoPoint elements can be present because one location may indicate the location of the scene\nin the image, and another location may indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1019,"character":13}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionGeoPoint","id":2508}}}],"groups":[{"title":"Properties","kind":1024,"children":[2468,2469,2470,2471,2472]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":991,"character":33}]},{"id":2347,"name":"VisionText","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A hierarchical representation of texts recognized in an image."},"children":[{"id":2349,"name":"blocks","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an array `VisionTextBlock`, which is a block of text that can be further decomposed to an array of `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":549,"character":10}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionTextBlock","id":2402}}},{"id":2348,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Retrieve the recognized text as a string."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":544,"character":8}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2349,2348]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":540,"character":29}],"extendedBy":[{"type":"reference","name":"VisionDocumentText","id":2393}]},{"id":2396,"name":"VisionTextBase","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A shared type that all Vision Text components inherit from"},"children":[{"id":2400,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":705,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506}},{"id":2398,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":693,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]}},{"id":2401,"name":"cornerPoints","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the four corner points in clockwise direction starting with top-left. Due to the possible perspective distortions, this is not necessarily a rectangle. Parts of the region could be outside of the image."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":710,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}}},{"id":2399,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":700,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}}},{"id":2397,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":688,"character":8}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2400,2398,2401,2399,2397]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":684,"character":33}],"extendedBy":[{"type":"reference","name":"VisionTextBlock","id":2402},{"type":"reference","name":"VisionTextLine","id":2409},{"type":"reference","name":"VisionTextElement","id":2416}]},{"id":2402,"name":"VisionTextBlock","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a block of text (similar to a paragraph)."},"children":[{"id":2407,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":705,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionTextBase.boundingBox","id":2400}},{"id":2405,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":693,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionTextBase.confidence","id":2398}},{"id":2408,"name":"cornerPoints","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the four corner points in clockwise direction starting with top-left. Due to the possible perspective distortions, this is not necessarily a rectangle. Parts of the region could be outside of the image."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":710,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}},"inheritedFrom":{"type":"reference","name":"VisionTextBase.cornerPoints","id":2401}},{"id":2403,"name":"lines","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an Array of VisionTextLine's that make up this text block."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":720,"character":9}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionTextLine","id":2409}}},{"id":2406,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":700,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionTextBase.recognizedLanguages","id":2399}},{"id":2404,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":688,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionTextBase.text","id":2397}}],"groups":[{"title":"Properties","kind":1024,"children":[2407,2405,2408,2403,2406,2404]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":716,"character":34}],"extendedTypes":[{"type":"reference","name":"VisionTextBase","id":2396}]},{"id":2416,"name":"VisionTextElement","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Roughly equivalent to a space-separated \"word\" in most Latin languages, or a character in others. For instance, if a word is split between two lines by a hyphen, each part is encoded as a separate Element."},"children":[{"id":2420,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":705,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionTextBase.boundingBox","id":2400}},{"id":2418,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":693,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionTextBase.confidence","id":2398}},{"id":2421,"name":"cornerPoints","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the four corner points in clockwise direction starting with top-left. Due to the possible perspective distortions, this is not necessarily a rectangle. Parts of the region could be outside of the image."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":710,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}},"inheritedFrom":{"type":"reference","name":"VisionTextBase.cornerPoints","id":2401}},{"id":2419,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":700,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionTextBase.recognizedLanguages","id":2399}},{"id":2417,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":688,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionTextBase.text","id":2397}}],"groups":[{"title":"Properties","kind":1024,"children":[2420,2418,2421,2419,2417]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":738,"character":36}],"extendedTypes":[{"type":"reference","name":"VisionTextBase","id":2396}]},{"id":2409,"name":"VisionTextLine","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a line of text."},"children":[{"id":2414,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":705,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionTextBase.boundingBox","id":2400}},{"id":2412,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":693,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionTextBase.confidence","id":2398}},{"id":2415,"name":"cornerPoints","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the four corner points in clockwise direction starting with top-left. Due to the possible perspective distortions, this is not necessarily a rectangle. Parts of the region could be outside of the image."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":710,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}},"inheritedFrom":{"type":"reference","name":"VisionTextBase.cornerPoints","id":2401}},{"id":2410,"name":"elements","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an Array of VisionTextElement's that make up this text block.","text":"An element is roughly equivalent to a space-separated \"word\" in most Latin languages, or a character in others. For instance, if a word is split between two lines by a hyphen, each part is encoded as a separate Element.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":732,"character":12}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionTextElement","id":2416}}},{"id":2413,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":700,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionTextBase.recognizedLanguages","id":2399}},{"id":2411,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":688,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionTextBase.text","id":2397}}],"groups":[{"title":"Properties","kind":1024,"children":[2414,2412,2415,2410,2413,2411]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":726,"character":33}],"extendedTypes":[{"type":"reference","name":"VisionTextBase","id":2396}]},{"id":2508,"name":"VisionGeoPoint","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"A representation of a latitude/longitude pair.","text":"This is expressed as an array of numbers representing degrees latitude and degrees longitude, in the form `[lat, lng]`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1027,"character":28}],"type":{"type":"tuple","elements":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"number"}]}},{"id":2507,"name":"VisionPoint","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"A point holds two number coordinates relative to the processed image.\nPoints are represented as [x, y].","text":"Used by Vision Text Recognizer, Face Detector & Landmark Recognition APIs.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":535,"character":25}],"type":{"type":"tuple","elements":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"number"}]}},{"id":2506,"name":"VisionRectangle","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"A Rectangle holds four number coordinates relative to the processed image.\nRectangle are represented as [left, top, right, bottom].","text":"Used by Vision Text Recognizer, Face Detector & Landmark Recognition APIs.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":527,"character":29}],"type":{"type":"tuple","elements":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Enumerations","kind":4,"children":[2320,2332,2377,2452,2335,2338,2341,2344,2438]},{"title":"Classes","kind":128,"children":[2473]},{"title":"Interfaces","kind":256,"children":[2287,2328,2311,2315,2323,2393,2387,2350,2357,2384,2371,2364,2426,2449,2303,2435,2422,2309,2467,2347,2396,2402,2416,2409]},{"title":"Type aliases","kind":4194304,"children":[2508,2507,2506]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":56,"character":36}]},{"id":2160,"name":"MLKitVision","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase ML Kit package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `ml-vision` package:\n\n```js\nimport { firebase } from '@react-native-firebase/ml-vision';\n\n// firebase.vision().X\n```\n\n#### Example 2\n\nUsing the default export from the `ml-vision` package:\n\n```js\nimport vision from '@react-native-firebase/ml-vision';\n\n// vision().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/ml-vision';\n\n// firebase.vision().X\n```\n","tags":[{"tag":"firebase","text":"ml-vision\n"}]},"children":[{"id":2268,"name":"VisionBarcodeAddressType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The type of a address detected in a barcode.","text":"Use with `VisionBarcodeAddress.type`.\n"},"children":[{"id":2271,"name":"HOME","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Address is specified as a HOME address."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":949,"character":8}],"defaultValue":"2"},{"id":2269,"name":"UNKNOWN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Unknown type"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":939,"character":11}],"defaultValue":"0"},{"id":2270,"name":"WORK","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Address is specified as a WORK address."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":944,"character":8}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2271,2269,2270]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":935,"character":38}]},{"id":2272,"name":"VisionBarcodeEmailType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The type of an email detected in a barcode.","text":"Use with `VisionBarcodeEmail.type`.\n"},"children":[{"id":2275,"name":"HOME","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Email address is specified as a HOME / personal email."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":971,"character":8}],"defaultValue":"2"},{"id":2273,"name":"UNKNOWN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Unknown type"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":961,"character":11}],"defaultValue":"0"},{"id":2274,"name":"WORK","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Email address is specified as a WORK email."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":966,"character":8}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2275,2273,2274]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":957,"character":36}]},{"id":2238,"name":"VisionBarcodeFormat","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Barcode format constants - enumeration of supported barcode formats.","text":"Can be used to specify the known type of a barcode before processing; via `VisionBarcodeDetectorOptions.setBarcodeFormats()`\n"},"children":[{"id":2239,"name":"ALL_FORMATS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant representing the union of all supported formats."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":772,"character":15}],"defaultValue":"0"},{"id":2240,"name":"AZTEC","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for AZTEC."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":777,"character":9}],"defaultValue":"4096"},{"id":2241,"name":"CODABAR","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for Codabar."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":782,"character":11}],"defaultValue":"8"},{"id":2242,"name":"CODE_128","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for Code 128."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":787,"character":12}],"defaultValue":"1"},{"id":2243,"name":"CODE_39","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for Code 39."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":792,"character":11}],"defaultValue":"2"},{"id":2244,"name":"CODE_93","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for Code 93."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":797,"character":11}],"defaultValue":"4"},{"id":2245,"name":"DATA_MATRIX","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for Data Matrix."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":802,"character":15}],"defaultValue":"16"},{"id":2246,"name":"EAN_13","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for EAN-13."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":807,"character":10}],"defaultValue":"32"},{"id":2247,"name":"EAN_8","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for EAN-8."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":812,"character":9}],"defaultValue":"64"},{"id":2248,"name":"ITF","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for ITF (Interleaved Two-of-Five)."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":817,"character":7}],"defaultValue":"128"},{"id":2249,"name":"PDF417","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for PDF-417."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":822,"character":10}],"defaultValue":"2048"},{"id":2250,"name":"QR_CODE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for QR Code."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":827,"character":11}],"defaultValue":"256"},{"id":2251,"name":"UNKNOWN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format unknown to the current SDK, but understood by Google Play services."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":832,"character":11}],"defaultValue":" -1"},{"id":2252,"name":"UPC_A","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for UPC-A."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":837,"character":9}],"defaultValue":"512"},{"id":2253,"name":"UPC_E","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for UPC-E."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":842,"character":9}],"defaultValue":"1024"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2239,2240,2241,2242,2243,2244,2245,2246,2247,2248,2249,2250,2251,2252,2253]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":768,"character":33}]},{"id":2276,"name":"VisionBarcodePhoneType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The type of a phone number detected in a barcode.","text":"Use with `VisionBarcodePhone.type`.\n"},"children":[{"id":2277,"name":"FAX","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Fax machine."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":983,"character":7}],"defaultValue":"3"},{"id":2278,"name":"HOME","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Home phone."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":988,"character":8}],"defaultValue":"2"},{"id":2279,"name":"MOBILE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Mobile Phone."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":993,"character":10}],"defaultValue":"4"},{"id":2280,"name":"UNKNOWN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Unknown type."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":998,"character":11}],"defaultValue":"0"},{"id":2281,"name":"WORK","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Work phone."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":1003,"character":8}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2277,2278,2279,2280,2281]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":979,"character":36}]},{"id":2254,"name":"VisionBarcodeValueType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Barcode value type constants - enumeration of supported barcode content value types.","text":"Can be used with `VisionBarcode.valueType` to determine the barcode content type of a detected barcode.\n\n#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\n// check for a calendar event barcode value type\nif (barcode && barcode.valueType === VisionBarcodeValueType.CALENDAR_EVENT) {\n  console.log(barcode.calendarEvent);\n}\n```\n"},"children":[{"id":2255,"name":"CALENDAR_EVENT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for calendar events."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":867,"character":18}],"defaultValue":"11"},{"id":2256,"name":"CONTACT_INFO","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for contact information."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":872,"character":16}],"defaultValue":"1"},{"id":2257,"name":"DRIVER_LICENSE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for driver's license data."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":877,"character":18}],"defaultValue":"12"},{"id":2258,"name":"EMAIL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for email message details."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":882,"character":9}],"defaultValue":"2"},{"id":2259,"name":"GEO","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for geographic coordinates."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":887,"character":7}],"defaultValue":"10"},{"id":2260,"name":"ISBN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for ISBNs."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":892,"character":8}],"defaultValue":"3"},{"id":2261,"name":"PHONE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for phone numbers."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":897,"character":9}],"defaultValue":"4"},{"id":2262,"name":"PRODUCT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for product codes."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":902,"character":11}],"defaultValue":"5"},{"id":2263,"name":"SMS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for SMS details."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":907,"character":7}],"defaultValue":"6"},{"id":2264,"name":"TEXT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for plain text."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":912,"character":8}],"defaultValue":"7"},{"id":2265,"name":"UNKNOWN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type unknown, which indicates the current version of SDK cannot recognize the structure of the barcode."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":917,"character":11}],"defaultValue":"0"},{"id":2266,"name":"URL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for URLs/bookmarks."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":922,"character":7}],"defaultValue":"8"},{"id":2267,"name":"WIFI","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for WiFi access point details."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":927,"character":8}],"defaultValue":"9"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2255,2256,2257,2258,2259,2260,2261,2262,2263,2264,2265,2266,2267]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":863,"character":36}]},{"id":2282,"name":"VisionBarcodeWifiEncryptionType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The type of wifi encryption used for a `VisionBarcodeWifi` instance.","text":"Use with `VisionBarcodeWifi.encryptionType`.\n"},"children":[{"id":2283,"name":"OPEN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Wifi has no encryption and is open."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":1015,"character":8}],"defaultValue":"1"},{"id":2285,"name":"WEP","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Wifi uses WEP encryption."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":1025,"character":7}],"defaultValue":"3"},{"id":2284,"name":"WPA","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Wifi uses WPA encryption. This includes WPA2."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":1020,"character":7}],"defaultValue":"2"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2283,2285,2284]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":1011,"character":45}]},{"id":2161,"name":"VisionBarcode","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A representation of a barcode detected in an image.","text":"#### Example\n\n```js\nconst [barcode, ...otherBarcodes] = await firebase.vision().barcodeDetectorProcessImage(filePath);\nconsole.log(barcode);\n```\n"},"children":[{"id":2162,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected barcode."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":52,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506}},{"id":2168,"name":"calendarEvent","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed calendar event (set if `valueType` is `VisionBarcodeValueType.CALENDAR_EVENT`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CALENDAR_EVENT) {\n  console.log(barcode.calendarEvent);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":113,"character":17}],"type":{"type":"reference","name":"VisionBarcodeCalendarEvent","id":2202}},{"id":2169,"name":"contactInfo","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed contact details (set if `valueType` is `VisionBarcodeValueType.CONTACT_INFO`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":130,"character":15}],"type":{"type":"reference","name":"VisionBarcodeContactInfo","id":2210}},{"id":2163,"name":"cornerPoints","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the four corner points in clockwise direction starting with top-left. Due to the possible perspective distortions, this is not necessarily a rectangle. Parts of the region could be outside of the image."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":57,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}}},{"id":2166,"name":"displayValue","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns barcode value in a user-friendly format.","text":"May omit some of the information encoded in the barcode. For example, if `'rawValue returns `MEBKM:TITLE:Invertase;URL://invertase.io;;'`, the display_value might be `'//invertase.io'`.\n\nIf `valueType` === `VisionBarcodeValueType.TEXT`, this field will be identical to `rawValue`.\n\nThis value can also be multiline, for example, when line breaks are encoded into the original `TEXT` barcode value.\n\nReturns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":87,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2170,"name":"driverLicense","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed drivers license details (set if `valueType` is `VisionBarcodeValueType.DRIVER_LICENSE`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.DRIVER_LICENSE) {\n  console.log(barcode.driverLicense);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":147,"character":17}],"type":{"type":"reference","name":"VisionBarcodeDriverLicense","id":2187}},{"id":2171,"name":"email","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed email details (set if `valueType` is `VisionBarcodeValueType.EMAIL`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.EMAIL) {\n  console.log(barcode.email);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":164,"character":9}],"type":{"type":"reference","name":"VisionBarcodeEmail","id":2229}},{"id":2164,"name":"format","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the barcode format, for example `VisionBarcodeFormat.QR_CODE`","text":"Use with `VisionBarcodeFormat` to switch based on format if needed.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":64,"character":10}],"type":{"type":"intrinsic","name":"number"}},{"id":2172,"name":"geoPoint","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed Geo Point details (set if `valueType` is `VisionBarcodeValueType.GEO`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.GEO) {\n  console.log(barcode.geoPoint);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":181,"character":12}],"type":{"type":"reference","name":"VisionGeoPoint","id":2508}},{"id":2173,"name":"phone","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed phone details (set if `valueType` is `VisionBarcodeValueType.PHONE`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.PHONE) {\n  console.log(barcode.phone);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":198,"character":9}],"type":{"type":"reference","name":"VisionBarcodePhone","id":2233}},{"id":2167,"name":"rawValue","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns barcode value as it was encoded in the barcode.","text":"Structured values are not parsed.\n\nReturns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":96,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2174,"name":"sms","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed sms details (set if `valueType` is `VisionBarcodeValueType.SMS`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.SMS) {\n  console.log(barcode.sms);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":215,"character":7}],"type":{"type":"reference","name":"VisionBarcodeSms","id":2184}},{"id":2175,"name":"url","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed url details (set if `valueType` is `VisionBarcodeValueType.URL`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.URL) {\n  console.log(barcode.url);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":232,"character":7}],"type":{"type":"reference","name":"VisionBarcodeUrl","id":2181}},{"id":2165,"name":"valueType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns type of the barcode value, for example `VisionBarcodeValueType.EMAIL`.","text":"If the value structure cannot be parsed, `VisionBarcodeValueType.TEXT` will be returned.\nIf the recognized structure type is not defined in the current version of the native Firebase SDKs, `VisionBarcodeValueType.UNKNOWN` will be returned.\n\nNote that the built-in parsers only recognize a few popular value structures. For your specific use case, you might want to directly consume `rawValue` and implement your own parsing logic.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":74,"character":13}],"type":{"type":"intrinsic","name":"number"}},{"id":2176,"name":"wifi","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed wifi details (set if `valueType` is `VisionBarcodeValueType.WIFI`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.WIFI) {\n  console.log(barcode.wifi);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":249,"character":8}],"type":{"type":"reference","name":"VisionBarcodeWifi","id":2177}}],"groups":[{"title":"Properties","kind":1024,"children":[2162,2168,2169,2163,2166,2170,2171,2164,2172,2173,2167,2174,2175,2165,2176]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":48,"character":32}]},{"id":2218,"name":"VisionBarcodeAddress","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A contacts address."},"children":[{"id":2219,"name":"lines","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An array of address line strings of the formatted address."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":602,"character":9}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2220,"name":"type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The address type, e.g. `VisionBarcodeAddressType.WORK`."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":607,"character":8}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[2219,2220]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":598,"character":39}]},{"id":2202,"name":"VisionBarcodeCalendarEvent","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A calendar event extracted from QRCode.","text":"```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CALENDAR_EVENT) {\n  console.log(barcode.calendarEvent);\n}\n```\n"},"children":[{"id":2203,"name":"description","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The description of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":486,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2204,"name":"end","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The end date time of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":493,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2205,"name":"location","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The location of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":500,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2206,"name":"organizer","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The organizer of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":507,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2207,"name":"start","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The start date time of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":514,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2208,"name":"status","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The status of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":521,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2209,"name":"summary","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The summary of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":528,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2203,2204,2205,2206,2207,2208,2209]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":480,"character":45}]},{"id":2210,"name":"VisionBarcodeContactInfo","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A persons or organization's business card. For example a VCARD.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo);\n}\n```\n"},"children":[{"id":2217,"name":"addresses","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an array of the contact persons addresses.","text":"Returns an empty array if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":592,"character":13}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionBarcodeAddress","id":2218}}},{"id":2215,"name":"emails","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the contact persons emails.","text":"Returns an empty array if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":580,"character":10}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionBarcodeEmail","id":2229}}},{"id":2216,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the contact persons name."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":585,"character":8}],"type":{"type":"reference","name":"VisionBarcodePersonName","id":2221}},{"id":2213,"name":"organization","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the contact persons organization.","text":"Returns `null` if no organization detected.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":566,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2214,"name":"phones","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the contact persons phones.","text":"Returns an empty array if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":573,"character":10}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionBarcodePhone","id":2233}}},{"id":2212,"name":"title","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the contact persons title. E.g. `Dr`","text":"Returns `null` if no title detected.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":559,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2211,"name":"urls","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Get an array of detected urls for the contact.","text":"Returns an empty array if nothing found;\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":552,"character":8}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"groups":[{"title":"Properties","kind":1024,"children":[2217,2215,2216,2213,2214,2212,2211]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":546,"character":43}]},{"id":2236,"name":"VisionBarcodeDetectorOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Custom options for barcode detection.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeFormat, VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath, {\n  barcodeFormats: [VisionBarcodeFormat.QR_CODE]\n});\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo);\n}\n```\n"},"children":[{"id":2237,"name":"barcodeFormats","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Set the barcode formats to detect.","text":"Defaults to `VisionBarcodeFormat.ALL_FORMATS`;\n","tags":[{"tag":"param","text":"Array of `VisionBarcodeFormat` types.\n","param":"formats"}]},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":760,"character":18}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionBarcodeFormat","id":2238}}}],"groups":[{"title":"Properties","kind":1024,"children":[2237]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":752,"character":47}]},{"id":2187,"name":"VisionBarcodeDriverLicense","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A driver license or ID card.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.DRIVER_LICENSE) {\n  console.log(barcode.driverLicense);\n}\n```\n"},"children":[{"id":2188,"name":"addressCity","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets city of holder's address.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":373,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2189,"name":"addressState","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets state of holder's address.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":380,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2190,"name":"addressStreet","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The holder's street address.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":387,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2191,"name":"addressZip","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The zip code of holder's address.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":394,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2192,"name":"birthDate","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The birth date of the holder.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":401,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2193,"name":"documentType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The \"DL\" for driver licenses, \"ID\" for ID cards.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":408,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2194,"name":"expiryDate","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The expiry date of the license.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":415,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2195,"name":"firstName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The holder's first name.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":422,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2196,"name":"gender","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The holder's gender.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":429,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2197,"name":"issueDate","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The issue date of the license.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":436,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2198,"name":"issuingCountry","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The country in which DL/ID was issued.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":443,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2199,"name":"lastName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The holder's last name.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":450,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2200,"name":"licenseNumber","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The driver license ID number.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":457,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2201,"name":"middleName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The holder's middle name.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":464,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2188,2189,2190,2191,2192,2193,2194,2195,2196,2197,2198,2199,2200,2201]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":367,"character":45}]},{"id":2229,"name":"VisionBarcodeEmail","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An email message from a 'MAILTO:' or similar QRCode type, or from a ContactInfo/VCARD.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.EMAIL) {\n  console.log(barcode.email);\n} else if (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo.emails[0]);\n}\n```\n"},"children":[{"id":2230,"name":"address","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The email address.","text":"Returns `null` if non detected for this `type`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":685,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2231,"name":"body","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The email body content.","text":"Returns `null` if no body detected.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":692,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2232,"name":"subject","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The email subject.","text":"Returns `null` if no subject was detected.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":699,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2230,2231,2232]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":679,"character":37}]},{"id":2221,"name":"VisionBarcodePersonName","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A persons name, both formatted version and their individual name components."},"children":[{"id":2222,"name":"first","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The persons first name.","text":"Returns `null` if not found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":619,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2223,"name":"formatted","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A properly formatted name.","text":"Returns `null` if no name components found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":626,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2224,"name":"last","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The persons last name.","text":"Returns `null` if not found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":633,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2225,"name":"middle","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The persons middle name.","text":"Returns `null` if not found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":640,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2226,"name":"prefix","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The prefix of the name.","text":"Returns `null` if not found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":647,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2227,"name":"pronunciation","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Designates a text string to be set as the kana name in the phonebook."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":652,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2228,"name":"suffix","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The suffix of the persons name.","text":"Returns `null` if not found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":659,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2222,2223,2224,2225,2226,2227,2228]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":613,"character":42}]},{"id":2233,"name":"VisionBarcodePhone","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A phone number and it's detected type, e.g. `VisionBarcodePhoneType.MOBILE`","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.PHONE) {\n  console.log(barcode.phone);\n} else if (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo.phones[0]);\n}\n```\n"},"children":[{"id":2234,"name":"number","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The detected phone number.","text":"Returns `null` if no number detected for this type.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":725,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2235,"name":"type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets type of the phone number, e.g. `VisionBarcodePhoneType.MOBILE`.","text":"See also `VisionBarcodePhoneType`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":732,"character":8}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[2234,2235]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":719,"character":37}]},{"id":2184,"name":"VisionBarcodeSms","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An sms message from an 'SMS:' or similar QRCode type.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.SMS) {\n  console.log(barcode.sms);\n}\n```\n"},"children":[{"id":2185,"name":"message","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The message text for this SMS.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":342,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2186,"name":"phoneNumber","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The phone number for this SMS.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":349,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2185,2186]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":336,"character":35}]},{"id":2181,"name":"VisionBarcodeUrl","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A URL and title from a 'MEBKM:' or similar QRCode type.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.URL) {\n  console.log(barcode.url);\n}\n```\n"},"children":[{"id":2182,"name":"title","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The title for this url.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":311,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2183,"name":"url","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The URL.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":318,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2182,2183]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":305,"character":35}]},{"id":2177,"name":"VisionBarcodeWifi","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Wifi network parameters from a 'WIFI:' or similar QRCode type.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.WIFI) {\n  console.log(barcode.wifi);\n}\n```\n"},"children":[{"id":2178,"name":"encryptionType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The encryption type of the WIFI. e.g. `VisionBarcodeWifiEncryptionType.WPA`","text":"See all types at `VisionBarcodeWifiEncryptionType`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":273,"character":18}],"type":{"type":"intrinsic","name":"number"}},{"id":2179,"name":"password","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The password for this WIFI.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":280,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2180,"name":"ssid","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The SSID for this WIFI.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":287,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2178,2179,2180]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":267,"character":36}]}],"groups":[{"title":"Enumerations","kind":4,"children":[2268,2272,2238,2276,2254,2282]},{"title":"Interfaces","kind":256,"children":[2161,2218,2202,2210,2236,2187,2229,2221,2233,2184,2181,2177]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":37,"character":28}]},{"id":1,"name":"ReactNativeFirebase","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Core React Native Firebase package.","text":"#### Example 1\n\nAccess the default firebase app from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\n\nconsole.log(firebase.app().name);\n```\n","tags":[{"tag":"firebase","text":"app\n"}]},"children":[{"id":46,"name":"FirebaseModule","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A class that all React Native Firebase modules extend from to provide default behaviour."},"children":[{"id":47,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"}},{"id":49,"name":"emitter","kind":1024,"kindString":"Property","flags":{"isPrivate":true,"isExported":true},"comment":{"shortText":"Returns the shared event emitter instance used for all JS event routing."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":211,"character":19}],"type":{"type":"intrinsic","name":"any"}},{"id":48,"name":"native","kind":1024,"kindString":"Property","flags":{"isPrivate":true,"isExported":true},"comment":{"shortText":"The native module instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":206,"character":18}],"type":{"type":"intrinsic","name":"any"}}],"groups":[{"title":"Properties","kind":1024,"children":[47,49,48]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":197,"character":29}],"extendedBy":[{"type":"reference","name":"Module","id":77},{"type":"reference","name":"Module","id":243},{"type":"reference","name":"Module","id":428},{"type":"reference","name":"Module","id":746},{"type":"reference","name":"Module","id":843},{"type":"reference","name":"Module","id":1185},{"type":"reference","name":"Module","id":1265},{"type":"reference","name":"Module","id":1818},{"type":"reference","name":"Module","id":1890},{"type":"reference","name":"Module","id":1909},{"type":"reference","name":"Module","id":1932},{"type":"reference","name":"Module","id":2020},{"type":"reference","name":"Module","id":2133},{"type":"reference","name":"Module","id":2473},{"type":"reference","name":"Module","id":2601},{"type":"reference","name":"Module","id":2651},{"type":"reference","name":"Module","id":2840}]},{"id":28,"name":"FirebaseApp","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":29,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The name (identifier) for this App. '[DEFAULT]' is the default App."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":140,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":30,"name":"options","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The (read-only) configuration options from the app initialization."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":145,"character":20}],"type":{"type":"reference","name":"FirebaseAppOptions","id":11}},{"id":31,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":32,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Make this app unusable and free up resources."},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":150,"character":10}]}],"groups":[{"title":"Properties","kind":1024,"children":[29,30]},{"title":"Methods","kind":2048,"children":[31]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":136,"character":30}]},{"id":24,"name":"FirebaseAppConfig","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":26,"name":"automaticDataCollectionEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":127,"character":34}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":27,"name":"automaticResourceManagement","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If set to true it indicates that Firebase should close database connections\nautomatically when the app is in the background. Disabled by default."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":133,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":25,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Firebase App name, defaults to [DEFAULT] if none provided."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":122,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[26,27,25]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":118,"character":36}]},{"id":11,"name":"FirebaseAppOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"indexSignature":[{"id":22,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":23,"name":"name","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"children":[{"id":20,"name":"androidClientId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"iOS only - The Android client ID used in Google AppInvite when an iOS app has its Android version, for\nexample \"12345.apps.googleusercontent.com\"."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":109,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":13,"name":"apiKey","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An API key used for authenticating requests from your app, e.g.\n\"AIzaSyDdVgKwhZl0sTTTLZ7iTmt1r3N2cJLnaDk\", used to identify your app to Google servers."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":71,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":12,"name":"appId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Google App ID that is used to uniquely identify an instance of an app."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":65,"character":9}],"type":{"type":"intrinsic","name":"string"}},{"id":19,"name":"clientId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"iOS only - The OAuth2 client ID for iOS application used to authenticate Google users, for example\n\"12345.apps.googleusercontent.com\", used for signing in with Google."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":103,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":14,"name":"databaseURL","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The database root URL, e.g. \"http://abc-xyz-123.firebaseio.com\"."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":76,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":21,"name":"deepLinkURLScheme","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"iOS only - The URL scheme used to set up Durable Deep Link service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":114,"character":21}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":16,"name":"gaTrackingId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The tracking ID for Google Analytics, e.g. \"UA-12345678-1\", used to configure Google Analytics."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":86,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":18,"name":"messagingSenderId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Project Number from the Google Developer's console, for example \"012345678901\", used to\nconfigure Google Cloud Messaging."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":97,"character":21}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":15,"name":"projectId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Project ID from the Firebase console, for example \"abc-xyz-123\"."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":81,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":17,"name":"storageBucket","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Google Cloud Storage bucket name, e.g. \"abc-xyz-123.storage.firebase.com\"."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":91,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[20,13,12,19,14,21,16,18,15,17]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":61,"character":37}]},{"id":50,"name":"FirebaseJsonConfig","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"React Native Firebase `firebase.json` config"},"children":[{"id":272,"name":"admob_android_app_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Google AdMob application App ID for Android.","text":"This can be found under: Apps > App settings > App ID on the Google AdMob dashboard.\n\nFor testing purposes, use the App ID: `ca-app-pub-3940256099942544~3347511713`.\n","tags":[{"tag":"android","text":"\n"}]},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1221,"character":24}],"type":{"type":"intrinsic","name":"string"}},{"id":274,"name":"admob_delay_app_measurement_init","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"By default, the Google Mobile Ads SDK initializes app measurement and begins sending user-level event data to\nGoogle immediately when the app starts. This initialization behavior ensures you can enable AdMob user metrics\nwithout making additional code changes.","text":"If you require your app users to provide consent before collecting data, setting the value to `true` will prevent\ndata being sent until the `firebase.admob().initialize()` method has been called.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1242,"character":36}],"type":{"type":"intrinsic","name":"boolean"}},{"id":273,"name":"admob_ios_app_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Google AdMob application App ID for iOS.","text":"This can be found under: Apps > App settings > App ID on the Google AdMob dashboard.\n\nFor testing purposes, use the App ID: `ca-app-pub-3940256099942544~1458002511`.\n","tags":[{"tag":"ios","text":"\n"}]},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1232,"character":20}],"type":{"type":"intrinsic","name":"string"}},{"id":555,"name":"analytics_auto_collection_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Disable or enable auto collection of analytics data.","text":"This is useful for opt-in-first data flows, for example when dealing with GDPR compliance.\nThis can be overridden in JavaScript.\n\n#### Example\n\n```json\n// <project-root>/firebase.json\n{\n  \"react-native\": {\n    \"analytics_auto_collection_enabled\": false\n  }\n}\n```\n\n```js\n// Re-enable analytics data collection, e.g. once user has granted permission:\nawait firebase.analytics().setAnalyticsCollectionEnabled(true);\n```\n"},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1407,"character":37}],"type":{"type":"intrinsic","name":"boolean"}},{"id":885,"name":"crashlytics_auto_collection_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":263,"character":39}],"type":{"type":"intrinsic","name":"boolean"}},{"id":884,"name":"crashlytics_debug_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":262,"character":29}],"type":{"type":"intrinsic","name":"boolean"}},{"id":883,"name":"crashlytics_ndk_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":261,"character":27}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1217,"name":"database_persistence_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Set whether database persistence is enabled or disabled.","text":"This can be overridden in JavaScript, e.g. when requesting permission or on a condition.\n\n#### Example\n\n```json\n// <project-root>/firebase.json\n{\n  \"react-native\": {\n    \"database_persistence_enabled\": false\n  }\n}\n```\n\n```js\n// Re-enable database persistence\nawait firebase.database().setPersistenceEnabled(true);\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1288,"character":32}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1949,"name":"in_app_messaging_auto_collection_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Disable or enable auto collection & receiving of in-app messages and data collection.","text":"This is useful for opt-in-first data flows, for example when dealing with GDPR compliance.\nThis can be overridden in JavaScript.\n\n#### Example\n\n```json\n// <project-root>/firebase.json\n{\n  \"react-native\": {\n    \"in_app_messaging_auto_collection_enabled\": false\n  }\n}\n```\n\n```js\n// Re-enable in-app messaging, e.g. once user has granted permission:\nawait firebase.inAppMessaging().setAutomaticDataCollectionEnabled(true);\n```\n"},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":194,"character":44}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2121,"name":"messaging_android_headless_task_timeout","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":966,"character":43}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":2122,"name":"messaging_android_notification_channel_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":967,"character":45}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2123,"name":"messaging_android_notification_color","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":968,"character":40}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2120,"name":"messaging_auto_init_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":965,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2158,"name":"ml_natural_language_language_id_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If `true`, the Language ID Model will be installed onto the device."},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":267,"character":41}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2159,"name":"ml_natural_language_smart_reply_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If `true`, the Smart Reply Model will be installed onto the device."},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":272,"character":41}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2533,"name":"ml_vision_barcode_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1233,"character":27}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2531,"name":"ml_vision_face_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1231,"character":24}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2535,"name":"ml_vision_image_label_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1235,"character":31}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2534,"name":"ml_vision_label_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1234,"character":25}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2532,"name":"ml_vision_ocr_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1232,"character":23}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2625,"name":"perf_auto_collection_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Disable or enable auto collection of performance monitoring data collection.","text":"This is useful for opt-in-first data flows, for example when dealing with GDPR compliance.\nThis can be overridden in JavaScript.\n\n#### Example\n\n```json\n// <project-root>/firebase.json\n{\n  \"react-native\": {\n    \"perf_auto_collection_enabled\": false\n  }\n}\n```\n\n```js\n// Re-enable performance monitoring data collection, e.g. once user has granted permission:\nawait firebase.perf().setPerformanceCollectionEnabled(true);\n```\n"},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":503,"character":32}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[272,274,273,555,885,884,883,1217,1949,2121,2122,2123,2120,2158,2159,2533,2531,2535,2534,2532,2625]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":235,"character":37},{"fileName":"packages/admob/lib/index.d.ts","line":1211,"character":30},{"fileName":"packages/analytics/lib/index.d.ts","line":1384,"character":30},{"fileName":"packages/crashlytics/lib/index.d.ts","line":260,"character":30},{"fileName":"packages/database/lib/index.d.ts","line":1266,"character":30},{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":171,"character":30},{"fileName":"packages/messaging/lib/index.d.ts","line":964,"character":30},{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":263,"character":30},{"fileName":"packages/ml-vision/lib/index.d.ts","line":1230,"character":30},{"fileName":"packages/perf/lib/index.d.ts","line":480,"character":30}]},{"id":33,"name":"Module","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":45,"name":"SDK_VERSION","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current React Native Firebase version."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":191,"character":24}],"type":{"type":"intrinsic","name":"string"}},{"id":44,"name":"apps","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A (read-only) array of all the initialized Apps."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":186,"character":8}],"type":{"type":"array","elementType":{"type":"reference","name":"FirebaseApp"}}},{"id":41,"name":"app","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":42,"name":"app","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Retrieve an instance of a FirebaseApp.","tags":[{"tag":"example","text":"\n```js\nconst app = firebase.app('foo');\n```\n"}]},"parameters":[{"id":43,"name":"name","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The optional name of the app to return ('[DEFAULT]' if omitted)\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"FirebaseApp"}}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":181,"character":7}]},{"id":34,"name":"initializeApp","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":35,"name":"initializeApp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Create (and initialize) a FirebaseApp."},"parameters":[{"id":36,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options to configure the services used in the App."},"type":{"type":"reference","name":"FirebaseAppOptions","id":11}},{"id":37,"name":"config","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The optional config for your firebase app\n"},"type":{"type":"reference","name":"FirebaseAppConfig","id":24}}],"type":{"type":"reference","name":"FirebaseApp"}},{"id":38,"name":"initializeApp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Create (and initialize) a FirebaseApp."},"parameters":[{"id":39,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options to configure the services used in the App."},"type":{"type":"reference","name":"FirebaseAppOptions","id":11}},{"id":40,"name":"name","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The optional name of the app to initialize ('[DEFAULT]' if\nomitted)\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"FirebaseApp"}}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":160,"character":17},{"fileName":"packages/app/lib/index.d.ts","line":169,"character":17}]}],"groups":[{"title":"Properties","kind":1024,"children":[45,44]},{"title":"Methods","kind":2048,"children":[41,34]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":153,"character":25}]},{"id":2,"name":"NativeFirebaseError","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":10,"name":"Error","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":984,"character":17}],"type":{"type":"reference","name":"ErrorConstructor"}},{"id":3,"name":"code","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Firebase error code, e.g. `auth/invalid-email`"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":38,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":4,"name":"message","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Firebase error message"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":43,"character":20}],"type":{"type":"intrinsic","name":"string"},"overwrites":{"type":"reference","name":"Error.message"}},{"id":8,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":973,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"Error.name"}},{"id":5,"name":"namespace","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The firebase module namespace that this error originated from, e.g. 'analytics'"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":48,"character":22}],"type":{"type":"intrinsic","name":"string"}},{"id":6,"name":"nativeErrorCode","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The native sdks returned error code, different per platform"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":53,"character":28}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"}]}},{"id":7,"name":"nativeErrorMessage","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The native sdks returned error message, different per platform"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":58,"character":31}],"type":{"type":"intrinsic","name":"string"}},{"id":9,"name":"stack","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":975,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]},"overwrites":{"type":"reference","name":"Error.stack"},"inheritedFrom":{"type":"reference","name":"Error.stack"}}],"groups":[{"title":"Properties","kind":1024,"children":[10,3,4,8,5,6,7,9]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":34,"character":38}],"extendedTypes":[{"type":"reference","name":"Error"}]},{"id":51,"name":"FirebaseModuleWithStatics","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"typeParameter":[{"id":52,"name":"M","kind":131072,"kindString":"Type parameter","flags":{}},{"id":53,"name":"S","kind":131072,"kindString":"Type parameter","flags":{}}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":214,"character":39}],"type":{"type":"intersection","types":[{"type":"reflection","declaration":{"id":54,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":55,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"typeParameter","name":"M"}}],"children":[{"id":56,"name":"SDK_VERSION","kind":32,"kindString":"Variable","flags":{},"comment":{"shortText":"This React Native Firebase module version."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":220,"character":24}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Variables","kind":32,"children":[56]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":214,"character":52}]}},{"type":"typeParameter","name":"S"}]}},{"id":57,"name":"FirebaseModuleWithStaticsAndApp","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"typeParameter":[{"id":58,"name":"M","kind":131072,"kindString":"Type parameter","flags":{}},{"id":59,"name":"S","kind":131072,"kindString":"Type parameter","flags":{}}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":223,"character":45}],"type":{"type":"intersection","types":[{"type":"reflection","declaration":{"id":60,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":61,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":62,"name":"app","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"FirebaseApp","id":28}}],"type":{"type":"typeParameter","name":"M"}}],"children":[{"id":63,"name":"SDK_VERSION","kind":32,"kindString":"Variable","flags":{},"comment":{"shortText":"This React Native Firebase module version."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":229,"character":24}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Variables","kind":32,"children":[63]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":223,"character":58}]}},{"type":"typeParameter","name":"S"}]}}],"groups":[{"title":"Classes","kind":128,"children":[46]},{"title":"Interfaces","kind":256,"children":[28,24,11,50,33,2]},{"title":"Type aliases","kind":4194304,"children":[51,57]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":33,"character":36},{"fileName":"packages/admob/lib/index.d.ts","line":1210,"character":29},{"fileName":"packages/analytics/lib/index.d.ts","line":1383,"character":29},{"fileName":"packages/crashlytics/lib/index.d.ts","line":259,"character":29},{"fileName":"packages/database/lib/index.d.ts","line":1265,"character":29},{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":170,"character":29},{"fileName":"packages/messaging/lib/index.d.ts","line":963,"character":29},{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":262,"character":29},{"fileName":"packages/ml-vision/lib/index.d.ts","line":1229,"character":29},{"fileName":"packages/perf/lib/index.d.ts","line":479,"character":29}]},{"id":64,"name":"Utils","kind":2,"kindString":"Module","flags":{"isExported":true},"children":[{"id":77,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The React Native Firebase Utils service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Utils service for the default app:\n\n```js\nconst defaultAppUtils = firebase.utils();\n```\n"},"children":[{"id":79,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":78,"name":"isRunningInTestLab","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns true if this app is running inside a Firebase Test Lab environment. Always returns false on iOS.","tags":[{"tag":"android","text":"\n"}]},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":381,"character":22}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[79,78]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":375,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":65,"name":"FilePath","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A collection of native device file paths to aid in the usage of file path based methods.","text":"Concatenate a file path with your target file name when using with Storage `putFile` or `writeToFile`.\n\n```js\nfirebase.utils.FilePath;\n```\n"},"children":[{"id":67,"name":"CACHES_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to the application specific cache directory on the filesystem.","text":"The system will automatically delete files in this directory when disk space is needed elsewhere on the device, starting with the oldest files first.\n\n```js\nfirebase.utils.FilePath.CACHES_DIRECTORY;\n```\n"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":274,"character":20}],"type":{"type":"intrinsic","name":"string"}},{"id":68,"name":"DOCUMENT_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to the users Documents directory.","text":"Use this directory to place documents that have been created by the user.\n\n```js\nfirebase.utils.FilePath.DOCUMENT_DIRECTORY;\n```\n"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":285,"character":22}],"type":{"type":"intrinsic","name":"string"}},{"id":71,"name":"EXTERNAL_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to the directory on the primary shared/external storage device.","text":"Here your application can place persistent files it owns. These files are internal to the application, and not typically visible to the user as media.\n\nReturns null if no external storage directory found, e.g. removable media has been ejected by the user.\n\n```js\nfirebase.utils.FilePath.EXTERNAL_DIRECTORY;\n```\n","tags":[{"tag":"android","text":"Android only - iOS returns null\n"}]},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":322,"character":22}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":72,"name":"EXTERNAL_STORAGE_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to the primary shared/external storage directory.","text":"Traditionally this is an SD card, but it may also be implemented as built-in storage on a device.\n\nReturns null if no external storage directory found, e.g. removable media has been ejected by the user.\n\n```js\nfirebase.utils.FilePath.EXTERNAL_STORAGE_DIRECTORY;\n```\n","tags":[{"tag":"android","text":"Android only - iOS returns null\n"}]},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":337,"character":30}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":70,"name":"LIBRARY_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to the apps library/resources directory.","text":"E.g. this can be used for things like documentation, support files, and configuration files and generic resources.\n\n```js\nfirebase.utils.FilePath.LIBRARY_DIRECTORY;\n```\n"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":307,"character":21}],"type":{"type":"intrinsic","name":"string"}},{"id":66,"name":"MAIN_BUNDLE","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to the applications main bundle.","text":"```js\nfirebase.utils.FilePath.MAIN_BUNDLE;\n```\n","tags":[{"tag":"ios","text":"iOS only\n"}]},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":263,"character":15}],"type":{"type":"intrinsic","name":"string"}},{"id":74,"name":"MOVIES_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to a directory in which to place movies that are available to the user.","text":"```js\nfirebase.utils.FilePath.MOVIES_DIRECTORY;\n```\n"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":355,"character":20}],"type":{"type":"intrinsic","name":"string"}},{"id":73,"name":"PICTURES_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to a directory in which to place pictures that are available to the user.","text":"```js\nfirebase.utils.FilePath.PICTURES_DIRECTORY;\n```\n"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":346,"character":22}],"type":{"type":"intrinsic","name":"string"}},{"id":69,"name":"TEMP_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to a temporary directory.","text":"Use this directory to create temporary files. The system will automatically delete files in this directory when disk space is needed elsewhere on the device, starting with the oldest files first.\n\n```js\nfirebase.utils.FilePath.TEMP_DIRECTORY;\n```\n"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":296,"character":18}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[67,68,71,72,70,66,74,73,69]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":253,"character":27}]},{"id":75,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":76,"name":"FilePath","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":359,"character":12}],"type":{"type":"reference","name":"FilePath","id":65}}],"groups":[{"title":"Properties","kind":1024,"children":[76]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":358,"character":26}]}],"groups":[{"title":"Classes","kind":128,"children":[77]},{"title":"Interfaces","kind":256,"children":[65,75]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":241,"character":22}]},{"id":2868,"name":"interstitial","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/admob/type-test.ts","line":61,"character":18}],"type":{"type":"reference","name":"InterstitialAd","id":204},"defaultValue":" admob.InterstitialAd.createForAdRequest('foo', {\n  keywords: ['test'],\n})"},{"id":2873,"name":"metric","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/perf/type-test.ts","line":46,"character":12}],"type":{"type":"reference","name":"HttpMetric","id":2568},"defaultValue":" firebase.perf().newHttpMetric('foo', 'GET')"},{"id":2871,"name":"r","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/database/type-test.ts","line":55,"character":7}],"type":{"type":"reference","name":"Reference","id":894},"defaultValue":" firebase.database().ref('foo')"},{"id":2874,"name":"ref","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/storage/type-test.ts","line":41,"character":9}],"type":{"type":"reference","name":"Reference","id":2731},"defaultValue":" firebase.storage().ref('foo')"},{"id":2869,"name":"rewardedAd","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/admob/type-test.ts","line":95,"character":16}],"type":{"type":"reference","name":"RewardedAd","id":219},"defaultValue":" admob.RewardedAd.createForAdRequest('foo', {\n  keywords: ['test'],\n})"},{"id":2875,"name":"task","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/storage/type-test.ts","line":54,"character":10}],"type":{"type":"reference","name":"Task","id":2785},"defaultValue":" firebase\n  .storage()\n  .ref('foo')\n  .putString('foo')"},{"id":2872,"name":"trace","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/perf/type-test.ts","line":36,"character":11}],"type":{"type":"reference","name":"Trace","id":2537},"defaultValue":" firebase.perf().newTrace('foo')"},{"id":2870,"name":"u","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/auth/type-test.ts","line":49,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"reference","name":"User","id":699}]},"defaultValue":" firebase.auth().currentUser"}],"groups":[{"title":"Modules","kind":2,"children":[254,548,80,834,876,1209,1286,1850,1899,1923,1942,2113,2151,2509,2618,2677,2860,89,275,556,841,886,1218,1293,1857,1907,1930,2124,1950,2536,2626,2684,2286,2160,1,64]},{"title":"Variables","kind":32,"children":[2868,2873,2871,2874,2869,2875,2872,2870]}]}
\ No newline at end of file
+{"id":0,"name":"@react-native-firebase/app - v6.4.0-rc0","kind":0,"flags":{},"children":[{"id":254,"name":"\"@react-native-firebase/admob\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":261,"name":"AdEventType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1178,"character":26}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"AdEventType","id":98}]}},{"id":264,"name":"AdsConsent","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1181,"character":25}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"AdsConsent","id":121}]}},{"id":257,"name":"AdsConsentDebugGeography","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1174,"character":39}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"AdsConsentDebugGeography","id":161}]}},{"id":258,"name":"AdsConsentStatus","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1175,"character":31}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"AdsConsentStatus","id":165}]}},{"id":267,"name":"BannerAd","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1184,"character":23}],"type":{"type":"reference","name":"React.SFC","typeArguments":[{"type":"reference","name":"BannerAd","id":234}]}},{"id":262,"name":"BannerAdSize","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1179,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"BannerAdSize","id":108}]}},{"id":265,"name":"InterstitialAd","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1182,"character":29}],"type":{"type":"reference","name":"InterstitialAd","id":204}},{"id":259,"name":"MaxAdContentRating","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1176,"character":33}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"MaxAdContentRating","id":185}]}},{"id":266,"name":"RewardedAd","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1183,"character":25}],"type":{"type":"reference","name":"RewardedAd","id":219}},{"id":263,"name":"RewardedAdEventType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1180,"character":34}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"RewardedAdEventType","id":105}]}},{"id":260,"name":"TestIds","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1177,"character":22}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"TestIds","id":117}]}},{"id":268,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1186,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":243},{"type":"reference","name":"Statics","id":90}]}},{"id":256,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1172,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":255,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1171,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[261,264,257,258,267,262,265,259,266,263,260,268,256,255]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1163,"character":45}]},{"id":548,"name":"\"@react-native-firebase/analytics\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":551,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1357,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":428},{"type":"reference","name":"Statics","id":427}]}},{"id":550,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1355,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":549,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1354,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[551,550,549]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1348,"character":49}]},{"id":80,"name":"\"@react-native-firebase/app\"","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Attach namespace to `firebase.` and `FirebaseApp.`."},"children":[{"id":83,"name":"ReactNativeFirebase","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Attach Utils namespace to `firebase.` and `FirebaseApp.`."},"children":[{"id":86,"name":"FirebaseApp","kind":256,"kindString":"Interface","flags":{},"children":[{"id":270,"name":"admob","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":271,"name":"admob","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":243}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1205,"character":11}]},{"id":553,"name":"analytics","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":554,"name":"analytics","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":428}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1378,"character":15}]},{"id":839,"name":"auth","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":840,"name":"auth","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":746}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1639,"character":10}]},{"id":881,"name":"crashlytics","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":882,"name":"crashlytics","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":843}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":254,"character":17}]},{"id":1214,"name":"database","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":1215,"name":"database","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1216,"name":"databaseUrl","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Module","id":1185}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1260,"character":14}]},{"id":1291,"name":"dynamicLinks","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":1292,"name":"dynamicLinks","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":1265}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":595,"character":18}]},{"id":1855,"name":"firestore","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":1856,"name":"firestore","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":1818}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1974,"character":15}]},{"id":1904,"name":"functions","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":1905,"name":"functions","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1906,"name":"region","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Module","id":1890}}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":367,"character":15}]},{"id":1928,"name":"iid","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":1929,"name":"iid","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":1909}}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":159,"character":9}]},{"id":1947,"name":"inAppMessaging","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":1948,"name":"inAppMessaging","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":1932}}],"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":165,"character":20}]},{"id":2118,"name":"messaging","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":2119,"name":"messaging","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":2020}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":958,"character":15}]},{"id":2156,"name":"naturalLanguage","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":2157,"name":"naturalLanguage","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":2133}}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":257,"character":21}]},{"id":2623,"name":"perf","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":2624,"name":"perf","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":2601}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":474,"character":10}]},{"id":2682,"name":"remoteConfig","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":2683,"name":"remoteConfig","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":2651}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":458,"character":18}]},{"id":2865,"name":"storage","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":2866,"name":"storage","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2867,"name":"bucket","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Module","id":2840}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1129,"character":13}]},{"id":87,"name":"utils","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":88,"name":"utils","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":77}}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":415,"character":11}]},{"id":2529,"name":"vision","kind":2048,"kindString":"Method","flags":{},"signatures":[{"id":2530,"name":"vision","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"reference","name":"Module","id":2473}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1224,"character":12}]}],"groups":[{"title":"Methods","kind":2048,"children":[270,553,839,881,1214,1291,1855,1904,1928,1947,2118,2156,2623,2682,2865,87,2529]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":414,"character":25},{"fileName":"packages/admob/lib/index.d.ts","line":1204,"character":25},{"fileName":"packages/analytics/lib/index.d.ts","line":1377,"character":25},{"fileName":"packages/auth/lib/index.d.ts","line":1638,"character":25},{"fileName":"packages/crashlytics/lib/index.d.ts","line":253,"character":25},{"fileName":"packages/database/lib/index.d.ts","line":1259,"character":25},{"fileName":"packages/dynamic-links/lib/index.d.ts","line":594,"character":25},{"fileName":"packages/firestore/lib/index.d.ts","line":1973,"character":25},{"fileName":"packages/functions/lib/index.d.ts","line":366,"character":25},{"fileName":"packages/iid/lib/index.d.ts","line":158,"character":25},{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":164,"character":25},{"fileName":"packages/messaging/lib/index.d.ts","line":957,"character":25},{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":256,"character":25},{"fileName":"packages/ml-vision/lib/index.d.ts","line":1223,"character":25},{"fileName":"packages/perf/lib/index.d.ts","line":473,"character":25},{"fileName":"packages/remote-config/lib/index.d.ts","line":457,"character":25},{"fileName":"packages/storage/lib/index.d.ts","line":1128,"character":25}]},{"id":84,"name":"Module","kind":256,"kindString":"Interface","flags":{},"children":[{"id":269,"name":"admob","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1201,"character":11}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":243},{"type":"reference","name":"Statics","id":90}]}},{"id":552,"name":"analytics","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1371,"character":15}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":428},{"type":"reference","name":"Statics","id":427}]}},{"id":838,"name":"auth","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1636,"character":10}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":746},{"type":"reference","name":"Statics","id":587}]}},{"id":880,"name":"crashlytics","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":248,"character":17}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":843},{"type":"reference","name":"Statics","id":842}]}},{"id":1213,"name":"database","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1253,"character":14}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1185},{"type":"reference","name":"Statics","id":889}]}},{"id":1290,"name":"dynamicLinks","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":588,"character":18}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":1265},{"type":"reference","name":"Statics","id":1263}]}},{"id":1854,"name":"firestore","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1968,"character":15}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1818},{"type":"reference","name":"Statics","id":1808}]}},{"id":1903,"name":"functions","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":361,"character":15}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1890},{"type":"reference","name":"Statics","id":1888}]}},{"id":1927,"name":"iid","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":156,"character":9}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1909},{"type":"reference","name":"Statics","id":1908}]}},{"id":1946,"name":"inAppMessaging","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":158,"character":20}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":1932},{"type":"reference","name":"Statics","id":1931}]}},{"id":2117,"name":"messaging","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":951,"character":15}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":2020},{"type":"reference","name":"Statics","id":1951}]}},{"id":2155,"name":"naturalLanguage","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":250,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":2133},{"type":"reference","name":"Statics","id":2125}]}},{"id":2622,"name":"perf","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":468,"character":10}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":2601},{"type":"reference","name":"Statics","id":2600}]}},{"id":2681,"name":"remoteConfig","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":452,"character":18}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":2651},{"type":"reference","name":"Statics","id":2636}]}},{"id":2864,"name":"storage","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1123,"character":13}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":2840},{"type":"reference","name":"Statics","id":2698}]}},{"id":85,"name":"utils","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Utils provides a collection of utilities to aid in using Firebase\nand related services inside React Native, e.g. Test Lab helpers\nand Google Play Services version helpers."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":411,"character":11}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":77},{"type":"reference","name":"Statics","id":75}]}},{"id":2528,"name":"vision","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1217,"character":12}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":2473},{"type":"reference","name":"Statics","id":2287}]}}],"groups":[{"title":"Properties","kind":1024,"children":[269,552,838,880,1213,1290,1854,1903,1927,1946,2117,2155,2622,2681,2864,85,2528]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":405,"character":20},{"fileName":"packages/admob/lib/index.d.ts","line":1200,"character":20},{"fileName":"packages/analytics/lib/index.d.ts","line":1370,"character":20},{"fileName":"packages/auth/lib/index.d.ts","line":1635,"character":20},{"fileName":"packages/crashlytics/lib/index.d.ts","line":247,"character":20},{"fileName":"packages/database/lib/index.d.ts","line":1252,"character":20},{"fileName":"packages/dynamic-links/lib/index.d.ts","line":587,"character":20},{"fileName":"packages/firestore/lib/index.d.ts","line":1967,"character":20},{"fileName":"packages/functions/lib/index.d.ts","line":360,"character":20},{"fileName":"packages/iid/lib/index.d.ts","line":155,"character":20},{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":157,"character":20},{"fileName":"packages/messaging/lib/index.d.ts","line":950,"character":20},{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":249,"character":20},{"fileName":"packages/ml-vision/lib/index.d.ts","line":1216,"character":20},{"fileName":"packages/perf/lib/index.d.ts","line":467,"character":20},{"fileName":"packages/remote-config/lib/index.d.ts","line":451,"character":20},{"fileName":"packages/storage/lib/index.d.ts","line":1122,"character":20}]}],"groups":[{"title":"Interfaces","kind":256,"children":[86,84]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":402,"character":31},{"fileName":"packages/admob/lib/index.d.ts","line":1197,"character":31},{"fileName":"packages/analytics/lib/index.d.ts","line":1368,"character":31},{"fileName":"packages/auth/lib/index.d.ts","line":1633,"character":31},{"fileName":"packages/crashlytics/lib/index.d.ts","line":245,"character":31},{"fileName":"packages/database/lib/index.d.ts","line":1250,"character":31},{"fileName":"packages/dynamic-links/lib/index.d.ts","line":584,"character":31},{"fileName":"packages/firestore/lib/index.d.ts","line":1965,"character":31},{"fileName":"packages/functions/lib/index.d.ts","line":358,"character":31},{"fileName":"packages/iid/lib/index.d.ts","line":153,"character":31},{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":155,"character":31},{"fileName":"packages/messaging/lib/index.d.ts","line":948,"character":31},{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":246,"character":31},{"fileName":"packages/ml-vision/lib/index.d.ts","line":1214,"character":31},{"fileName":"packages/perf/lib/index.d.ts","line":465,"character":31},{"fileName":"packages/remote-config/lib/index.d.ts","line":449,"character":31},{"fileName":"packages/storage/lib/index.d.ts","line":1120,"character":31}]},{"id":82,"name":"module","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"comment":{"shortText":"Default Firebase export."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":394,"character":14}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"Module"}]}},{"id":81,"name":"utils","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"comment":{"shortText":"Add Utils module as a named export for `app`."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":389,"character":20}],"type":{"type":"reference","name":"ReactNativeFirebase.FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":77},{"type":"reference","name":"Statics","id":75}]}}],"groups":[{"title":"Modules","kind":2,"children":[83]},{"title":"Variables","kind":32,"children":[82,81]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":385,"character":43},{"fileName":"packages/app/lib/index.d.ts","line":398,"character":43},{"fileName":"packages/admob/lib/index.d.ts","line":1196,"character":43},{"fileName":"packages/analytics/lib/index.d.ts","line":1367,"character":43},{"fileName":"packages/auth/lib/index.d.ts","line":1632,"character":43},{"fileName":"packages/crashlytics/lib/index.d.ts","line":244,"character":43},{"fileName":"packages/database/lib/index.d.ts","line":1249,"character":43},{"fileName":"packages/dynamic-links/lib/index.d.ts","line":583,"character":43},{"fileName":"packages/firestore/lib/index.d.ts","line":1964,"character":43},{"fileName":"packages/functions/lib/index.d.ts","line":357,"character":43},{"fileName":"packages/iid/lib/index.d.ts","line":152,"character":43},{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":154,"character":43},{"fileName":"packages/messaging/lib/index.d.ts","line":947,"character":43},{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":245,"character":43},{"fileName":"packages/ml-vision/lib/index.d.ts","line":1213,"character":43},{"fileName":"packages/perf/lib/index.d.ts","line":464,"character":43},{"fileName":"packages/remote-config/lib/index.d.ts","line":448,"character":43},{"fileName":"packages/storage/lib/index.d.ts","line":1119,"character":43}]},{"id":834,"name":"\"@react-native-firebase/auth\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":837,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1622,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":746},{"type":"reference","name":"Statics","id":587}]}},{"id":836,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1620,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":835,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1619,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[837,836,835]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1613,"character":44}]},{"id":876,"name":"\"@react-native-firebase/crashlytics\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":879,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":234,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":843},{"type":"reference","name":"Statics","id":842}]}},{"id":878,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":232,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":877,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":231,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[879,878,877]}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":225,"character":51}]},{"id":1209,"name":"\"@react-native-firebase/database\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":1212,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1239,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1185},{"type":"reference","name":"Statics","id":889}]}},{"id":1211,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1237,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":1210,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1236,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[1212,1211,1210]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1230,"character":48}]},{"id":1286,"name":"\"@react-native-firebase/dynamic-links\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":1289,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":573,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":1265},{"type":"reference","name":"Statics","id":1263}]}},{"id":1288,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":571,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":1287,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":570,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[1289,1288,1287]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":564,"character":53}]},{"id":1850,"name":"\"@react-native-firebase/firestore\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":1853,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1954,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1818},{"type":"reference","name":"Statics","id":1808}]}},{"id":1852,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1952,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":1851,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1951,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[1853,1852,1851]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1945,"character":49}]},{"id":1899,"name":"\"@react-native-firebase/functions\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":1902,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":347,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1890},{"type":"reference","name":"Statics","id":1888}]}},{"id":1901,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":345,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":1900,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":344,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[1902,1901,1900]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":338,"character":49}]},{"id":1923,"name":"\"@react-native-firebase/iid\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":1926,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":142,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":1909},{"type":"reference","name":"Statics","id":1908}]}},{"id":1925,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":140,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":1924,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":139,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[1926,1925,1924]}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":133,"character":43}]},{"id":1942,"name":"\"@react-native-firebase/in-app-messaging\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":1944,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":142,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":1943,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":141,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}},{"id":1945,"name":"module","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":144,"character":14}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":1932},{"type":"reference","name":"Statics","id":1931}]}}],"groups":[{"title":"Variables","kind":32,"children":[1944,1943,1945]}],"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":135,"character":56}]},{"id":2113,"name":"\"@react-native-firebase/messaging\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":2116,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":937,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":2020},{"type":"reference","name":"Statics","id":1951}]}},{"id":2115,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":935,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":2114,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":934,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[2116,2115,2114]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":928,"character":49}]},{"id":2151,"name":"\"@react-native-firebase/ml-natural-language\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":2154,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":235,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":2133},{"type":"reference","name":"Statics","id":2125}]}},{"id":2153,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":233,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":2152,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":232,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[2154,2153,2152]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":226,"character":59}]},{"id":2509,"name":"\"@react-native-firebase/ml-vision\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":2518,"name":"VisionBarcodeAddressType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1193,"character":39}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"intrinsic","name":"any"}]}},{"id":2516,"name":"VisionBarcodeEmailType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1191,"character":37}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"intrinsic","name":"any"}]}},{"id":2512,"name":"VisionBarcodeFormat","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1187,"character":34}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"intrinsic","name":"any"}]}},{"id":2517,"name":"VisionBarcodePhoneType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1192,"character":37}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"intrinsic","name":"any"}]}},{"id":2515,"name":"VisionBarcodeValueType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1190,"character":37}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"intrinsic","name":"any"}]}},{"id":2521,"name":"VisionBarcodeWifiEncryptionType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1196,"character":46}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"FirebaseVisionTypes.VisionBarcodeWifiEncryptionType"}]}},{"id":2526,"name":"VisionCloudLandmarkRecognizerModelType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1201,"character":53}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionCloudLandmarkRecognizerModelType","id":2320}]}},{"id":2523,"name":"VisionCloudTextRecognizerModelType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1198,"character":49}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionCloudTextRecognizerModelType","id":2332}]}},{"id":2525,"name":"VisionDocumentTextRecognizedBreakType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1200,"character":52}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionDocumentTextRecognizedBreakType","id":2377}]}},{"id":2513,"name":"VisionFaceContourType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1188,"character":36}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionFaceContourType","id":2452}]}},{"id":2524,"name":"VisionFaceDetectorClassificationMode","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1199,"character":51}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionFaceDetectorClassificationMode","id":2335}]}},{"id":2519,"name":"VisionFaceDetectorContourMode","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1194,"character":44}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionFaceDetectorContourMode","id":2338}]}},{"id":2520,"name":"VisionFaceDetectorLandmarkMode","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1195,"character":45}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionFaceDetectorLandmarkMode","id":2341}]}},{"id":2522,"name":"VisionFaceDetectorPerformanceMode","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1197,"character":48}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionFaceDetectorPerformanceMode","id":2344}]}},{"id":2514,"name":"VisionFaceLandmarkType","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1189,"character":37}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"VisionFaceLandmarkType","id":2438}]}},{"id":2527,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1203,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":2473},{"type":"reference","name":"Statics","id":2287}]}},{"id":2511,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1185,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":2510,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1184,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[2518,2516,2512,2517,2515,2521,2526,2523,2525,2513,2524,2519,2520,2522,2514,2527,2511,2510]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1178,"character":49}]},{"id":2618,"name":"\"@react-native-firebase/perf\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":2621,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":454,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":2601},{"type":"reference","name":"Statics","id":2600}]}},{"id":2620,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":452,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":2619,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":451,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[2621,2620,2619]}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":445,"character":44}]},{"id":2677,"name":"\"@react-native-firebase/remote-config\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":2680,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":438,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStatics","id":51,"typeArguments":[{"type":"reference","name":"Module","id":2651},{"type":"reference","name":"Statics","id":2636}]}},{"id":2679,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":436,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":2678,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":435,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[2680,2679,2678]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":429,"character":53}]},{"id":2860,"name":"\"@react-native-firebase/storage\"","kind":2,"kindString":"Module","flags":{},"children":[{"id":2863,"name":"defaultExport","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1109,"character":21}],"type":{"type":"reference","name":"FirebaseModuleWithStaticsAndApp","id":57,"typeArguments":[{"type":"reference","name":"Module","id":2840},{"type":"reference","name":"Statics","id":2698}]}},{"id":2862,"name":"firebase","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1107,"character":23}],"type":{"type":"reference","name":"Module"},"defaultValue":" firebaseNamedExport"},{"id":2861,"name":"firebaseNamedExport","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1106,"character":27}],"type":{"type":"intersection","types":[{"type":"reference","name":"__type"},{"type":"reference","name":"ReactNativeFirebaseModule"}]}}],"groups":[{"title":"Variables","kind":32,"children":[2863,2862,2861]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1100,"character":47}]},{"id":89,"name":"FirebaseAdMobTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Admob package for React Native.","text":"#### Example: access the Firebase export from the `admob` package:\n\n```jS\nimport { firebase } from '@react-native-firebase/admob';\n\n// firebase.admob().X\n```\n\n#### Example: Using the default export from the `admob` package:\n\n```js\nimport admob from '@react-native-firebase/admob';\n\n// admob().X\n```\n\n#### Example: Using the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/admob';\n\n// firebase.admob().X\n```\n","tags":[{"tag":"firebase","text":"admob\n"}]},"children":[{"id":204,"name":"InterstitialAd","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A class for interacting and showing Interstitial Ads.","text":"An Interstitial advert can be pre-loaded and shown at a suitable point in your apps flow, such as at the end of a level\nin a game. An Interstitial is a full screen advert, laid on-top of your entire application which the user can interact with.\nInteractions are passed back via events which should be handled accordingly inside of your app.\n\n#### Example\n\nFirst create a new Interstitial instance, passing in your Ad Unit ID from the Firebase console, and any additional\nrequest options. The example below will present a test advert, and only request a non-personalized ad.\n\n```js\nimport { InterstitialAd, TestIds } from '@react-native-firebase/admob';\n\nconst interstitial = InterstitialAd.createForAdRequest(TestIds.INTERSTITIAL, {\n    requestNonPersonalizedAdsOnly: true,\n});\n ```\n\nEach advert needs to be loaded from AdMob before being shown. It is recommended this is performed before the user\nreaches the checkpoint to show the advert, so it's ready to go. Before loading the advert, we need to setup\nevent listeners to listen for updates from AdMob, such as advert loaded or failed to load.\n\nEvent types match the `AdEventType` interface. Once the advert has loaded, we can trigger it to show:\n\n```js\nimport { AdEventType } from '@react-native-firebase/admob';\n\ninterstitial.onAdEvent((type) => {\n  if (type === AdEventType.LOADED) {\n    interstitial.show();\n  }\n});\n\ninterstitial.load();\n ```\n\nThe advert will be presented to the user, and several more events can be triggered such as the user clicking the\nadvert or closing it.\n"},"children":[{"id":209,"name":"adUnitId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Ad Unit ID for this AdMob ad."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":845,"character":12}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"MobileAd.adUnitId","id":194}},{"id":210,"name":"loaded","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Whether the advert is loaded and can be shown."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":850,"character":10}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","name":"MobileAd.loaded","id":195}},{"id":211,"name":"load","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":212,"name":"load","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Start loading the advert with the provided RequestOptions.","text":"It is recommended you setup ad event handlers before calling this method.\n"},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","name":"MobileAd.load","id":196}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":857,"character":8}],"inheritedFrom":{"type":"reference","name":"MobileAd.load","id":196}},{"id":213,"name":"onAdEvent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":214,"name":"onAdEvent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to ad events. See AdEventTypes for more information.","text":"Returns an unsubscriber function to stop listening to further events.\n\n#### Example\n\n```js\n// Create InterstitialAd/RewardedAd\nconst advert = InterstitialAd.createForAdRequest('...');\n\nconst unsubscribe = advert.onAdEvent((type) => {\n\n});\n\n// Sometime later...\nunsubscribe();\n```\n"},"parameters":[{"id":215,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A listener callback containing a event type, error and data.\n"},"type":{"type":"reference","name":"AdEventListener","id":248}}],"type":{"type":"reference","name":"Function"},"inheritedFrom":{"type":"reference","name":"MobileAd.onAdEvent","id":198}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":880,"character":13}],"inheritedFrom":{"type":"reference","name":"MobileAd.onAdEvent","id":198}},{"id":216,"name":"show","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":217,"name":"show","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Show the loaded advert to the user.","text":"#### Example\n\n```js\n// Create InterstitialAd/RewardedAd\nconst advert = InterstitialAd.createForAdRequest('...');\n\nadvert.onAdEvent((type) => {\n  if (type === AdEventType.LOADED) {\n    advert.show({\n      immersiveModeEnabled: true,\n    });\n  }\n});\n```\n"},"parameters":[{"id":218,"name":"showOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional `AdShowOptions` interface.\n"},"type":{"type":"reference","name":"AdShowOptions","id":149}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"MobileAd.show","id":201}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":902,"character":8}],"inheritedFrom":{"type":"reference","name":"MobileAd.show","id":201}},{"id":205,"name":"createForAdRequest","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":206,"name":"createForAdRequest","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new InterstitialAd instance.","text":"#### Example\n\n```js\nimport { InterstitialAd, AdEventType, TestIds } from '@react-native-firebase/admob';\n\nconst interstitialAd = await InterstitialAd.request(TestIds.INTERSTITIAL, {\n  requestAgent: 'CoolAds',\n});\n\ninterstitialAd.onAdEvent((type, error) => {\n  console.log('New event: ', type, error);\n\n  if (type === AdEventType.LOADED) {\n    interstitialAd.show();\n  }\n});\n\ninterstitialAd.load();\n```\n"},"parameters":[{"id":207,"name":"adUnitId","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The Ad Unit ID for the Interstitial. You can find this on your Google AdMob dashboard."},"type":{"type":"intrinsic","name":"string"}},{"id":208,"name":"requestOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional RequestOptions used to load the ad.\n"},"type":{"type":"reference","name":"RequestOptions","id":169}}],"type":{"type":"reference","name":"InterstitialAd","id":204}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":973,"character":29}]}],"groups":[{"title":"Properties","kind":1024,"children":[209,210]},{"title":"Methods","kind":2048,"children":[211,213,216,205]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":946,"character":29}],"extendedTypes":[{"type":"reference","name":"MobileAd","id":193}]},{"id":193,"name":"MobileAd","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Base class for InterstitialAd, RewardedAd, NativeAd and BannerAd."},"children":[{"id":194,"name":"adUnitId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Ad Unit ID for this AdMob ad."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":845,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":195,"name":"loaded","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Whether the advert is loaded and can be shown."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":850,"character":10}],"type":{"type":"intrinsic","name":"boolean"}},{"id":196,"name":"load","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":197,"name":"load","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Start loading the advert with the provided RequestOptions.","text":"It is recommended you setup ad event handlers before calling this method.\n"},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":857,"character":8}]},{"id":198,"name":"onAdEvent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":199,"name":"onAdEvent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to ad events. See AdEventTypes for more information.","text":"Returns an unsubscriber function to stop listening to further events.\n\n#### Example\n\n```js\n// Create InterstitialAd/RewardedAd\nconst advert = InterstitialAd.createForAdRequest('...');\n\nconst unsubscribe = advert.onAdEvent((type) => {\n\n});\n\n// Sometime later...\nunsubscribe();\n```\n"},"parameters":[{"id":200,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A listener callback containing a event type, error and data.\n"},"type":{"type":"reference","name":"AdEventListener","id":248}}],"type":{"type":"reference","name":"Function"}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":880,"character":13}]},{"id":201,"name":"show","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":202,"name":"show","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Show the loaded advert to the user.","text":"#### Example\n\n```js\n// Create InterstitialAd/RewardedAd\nconst advert = InterstitialAd.createForAdRequest('...');\n\nadvert.onAdEvent((type) => {\n  if (type === AdEventType.LOADED) {\n    advert.show({\n      immersiveModeEnabled: true,\n    });\n  }\n});\n```\n"},"parameters":[{"id":203,"name":"showOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional `AdShowOptions` interface.\n"},"type":{"type":"reference","name":"AdShowOptions","id":149}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":902,"character":8}]}],"groups":[{"title":"Properties","kind":1024,"children":[194,195]},{"title":"Methods","kind":2048,"children":[196,198,201]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":841,"character":23}],"extendedBy":[{"type":"reference","name":"InterstitialAd","id":204},{"type":"reference","name":"RewardedAd","id":219}]},{"id":243,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Admob service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Admob service for the default app:\n\n```js\nconst defaultAppAdmob = firebase.admob();\n```\n"},"children":[{"id":247,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":244,"name":"setRequestConfiguration","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":245,"name":"setRequestConfiguration","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets request options for all future ad requests.","text":"#### Example\n\n```js\nimport admob, { MaxAdContentRating } from '@react-native-firebase/admob';\n\nawait admob().setRequestConfiguration({\n  // Update all future requests suitable for parental guidance\n  maxAdContentRating: MaxAdContentRating.PG,\n});\n```\n"},"parameters":[{"id":246,"name":"requestConfiguration","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An RequestConfiguration interface used on all future AdMob ad requests.\n"},"type":{"type":"reference","name":"RequestConfiguration","id":181}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1159,"character":27}]}],"groups":[{"title":"Properties","kind":1024,"children":[247]},{"title":"Methods","kind":2048,"children":[244]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1142,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":219,"name":"RewardedAd","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A class for interacting and showing Rewarded Ads.","text":"An Rewarded advert can be pre-loaded and shown at a suitable point in your apps flow, such as at the end of a level\nin a game. The content of a rewarded advert can be controlled via your AdMob dashboard. Typically users are rewarded\nafter completing a specific advert action (e.g. watching a video or submitting an option via an interactive form).\nEvents (such as the user earning a reward or closing a rewarded advert early) are sent back for you to handle accordingly\nwithin your application.\n\n#### Example\n\nFirst create a new Rewarded instance, passing in your Ad Unit ID from the Firebase console, and any additional\nrequest options. The example below will present a test advert, and only request a non-personalized ad.\n\n```js\nimport { RewardedAd, TestIds } from '@react-native-firebase/admob';\n\nconst rewarded = RewardedAd.createForAdRequest(TestIds.REWARDED, {\n    requestNonPersonalizedAdsOnly: true,\n});\n ```\n\nEach advert needs to be loaded from AdMob before being shown. It is recommended this is performed before the user\nreaches the checkpoint to show the advert, so it's ready to go. Before loading the advert, we need to setup\nevent listeners to listen for updates from AdMob, such as advert loaded or failed to load.\n\nEvent types match the `AdEventType` or `RewardedAdEventType` interface. The potential user reward for rewarded\nadverts are passed back to the event handler on advert load and when the user earns the reward.\n\n```js\nimport { RewardedAdEventType } from '@react-native-firebase/admob';\n\nrewarded.onAdEvent((type, error, reward) => {\n  if (type === RewardedAdEventType.LOADED) {\n    rewarded.show();\n  }\n  if (type === RewardedAdEventType.EARNED_REWARD) {\n    console.log('User earned reward of ', reward);\n  }\n});\n\nrewarded.load();\n ```\n\nThe rewarded advert will be presented to the user, and several more events can be triggered such as the user clicking the\nadvert, closing it or completing the action.\n"},"children":[{"id":224,"name":"adUnitId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Ad Unit ID for this AdMob ad."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":845,"character":12}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"MobileAd.adUnitId","id":194}},{"id":225,"name":"loaded","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Whether the advert is loaded and can be shown."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":850,"character":10}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","name":"MobileAd.loaded","id":195}},{"id":226,"name":"load","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":227,"name":"load","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Start loading the advert with the provided RequestOptions.","text":"It is recommended you setup ad event handlers before calling this method.\n"},"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","name":"MobileAd.load","id":196}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":857,"character":8}],"inheritedFrom":{"type":"reference","name":"MobileAd.load","id":196}},{"id":228,"name":"onAdEvent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":229,"name":"onAdEvent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to ad events. See AdEventTypes for more information.","text":"Returns an unsubscriber function to stop listening to further events.\n\n#### Example\n\n```js\n// Create InterstitialAd/RewardedAd\nconst advert = InterstitialAd.createForAdRequest('...');\n\nconst unsubscribe = advert.onAdEvent((type) => {\n\n});\n\n// Sometime later...\nunsubscribe();\n```\n"},"parameters":[{"id":230,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A listener callback containing a event type, error and data.\n"},"type":{"type":"reference","name":"AdEventListener","id":248}}],"type":{"type":"reference","name":"Function"},"inheritedFrom":{"type":"reference","name":"MobileAd.onAdEvent","id":198}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":880,"character":13}],"inheritedFrom":{"type":"reference","name":"MobileAd.onAdEvent","id":198}},{"id":231,"name":"show","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":232,"name":"show","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Show the loaded advert to the user.","text":"#### Example\n\n```js\n// Create InterstitialAd/RewardedAd\nconst advert = InterstitialAd.createForAdRequest('...');\n\nadvert.onAdEvent((type) => {\n  if (type === AdEventType.LOADED) {\n    advert.show({\n      immersiveModeEnabled: true,\n    });\n  }\n});\n```\n"},"parameters":[{"id":233,"name":"showOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional `AdShowOptions` interface.\n"},"type":{"type":"reference","name":"AdShowOptions","id":149}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"MobileAd.show","id":201}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":902,"character":8}],"inheritedFrom":{"type":"reference","name":"MobileAd.show","id":201}},{"id":220,"name":"createForAdRequest","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":221,"name":"createForAdRequest","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new RewardedAd instance.","text":"#### Example\n\n```js\nimport { RewardedAd, RewardedAdEventType, TestIds } from '@react-native-firebase/admob';\n\nconst rewardedAd = await RewardedAd.request(TestIds.REWARDED, {\n  requestAgent: 'CoolAds',\n});\n\nrewardedAd.onAdEvent((type, error, data) => {\n  console.log('New event: ', type, error);\n\n  if (type === RewardedAdEventType.LOADED) {\n    rewardedAd.show();\n  }\n});\n\nrewardedAd.load();\n```\n"},"parameters":[{"id":222,"name":"adUnitId","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The Ad Unit ID for the Rewarded Ad. You can find this on your Google AdMob dashboard."},"type":{"type":"intrinsic","name":"string"}},{"id":223,"name":"requestOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional RequestOptions used to load the ad.\n"},"type":{"type":"reference","name":"RequestOptions","id":169}}],"type":{"type":"reference","name":"RewardedAd","id":219}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1050,"character":29}]}],"groups":[{"title":"Properties","kind":1024,"children":[224,225]},{"title":"Methods","kind":2048,"children":[226,228,231,220]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1023,"character":25}],"extendedTypes":[{"type":"reference","name":"MobileAd","id":193}]},{"id":98,"name":"AdEventType","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Common event types for ads."},"children":[{"id":102,"name":"CLICKED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The user clicked the advert."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":140,"character":11}],"type":{"type":"stringLiteral","value":"clicked"}},{"id":104,"name":"CLOSED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The user closed the ad and has returned back to your application."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":152,"character":10}],"type":{"type":"stringLiteral","value":"closed"}},{"id":100,"name":"ERROR","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The ad has thrown an error. See the error parameter the listener callback for more information.","text":"#### Example\n\n```js\nimport { AdEventType } from '@react-native-firebase/admob';\n\nadvert.onAdEvent((type, error, data) => {\n  if (type === AdEventType.ERROR) {\n    console.log('Ad error:', error);\n  }\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":129,"character":9}],"type":{"type":"stringLiteral","value":"error"}},{"id":103,"name":"LEFT_APPLICATION","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The user has left your application (e.g. following the ad).","text":"Be sure to pause any tasks on this event (such as music or memory intensive tasks).\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":147,"character":20}],"type":{"type":"stringLiteral","value":"left_application"}},{"id":99,"name":"LOADED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"When an ad has loaded. At this point, the ad is ready to be shown to the user.","text":"#### Example\n\n```js\nimport { AdEventType } from '@react-native-firebase/admob';\n\nadvert.onAdEvent((type,error,data) => {\n  if (type === AdEventType.LOADED) {\n    advert.show();\n  }\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":112,"character":10}],"type":{"type":"stringLiteral","value":"loaded"}},{"id":101,"name":"OPENED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The ad opened and is currently visible to the user. This event is fired after the `show()`\nmethod has been called."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":135,"character":10}],"type":{"type":"stringLiteral","value":"opened"}}],"groups":[{"title":"Properties","kind":1024,"children":[102,104,100,103,99,101]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":96,"character":30}]},{"id":157,"name":"AdProvider","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A AdProvider interface returned from `AdsConsent.getProviders`."},"children":[{"id":158,"name":"companyId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A provider company ID."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":579,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":159,"name":"companyName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A provider company name."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":584,"character":15}],"type":{"type":"intrinsic","name":"string"}},{"id":160,"name":"privacyPolicyUrl","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A fully formed URL for the privacy policy of the provider."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":589,"character":20}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[158,159,160]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":575,"character":29}]},{"id":149,"name":"AdShowOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `AdShowOptions` interface used when showing an ad."},"children":[{"id":150,"name":"immersiveModeEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"- On Android, enables [immersive mode](https://developer.android.com/training/system-ui/immersive).\n- On iOS, this has no effect on how the ad is shown.","tags":[{"tag":"android","text":"\n"}]},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":525,"character":24}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[150]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":518,"character":32}]},{"id":121,"name":"AdsConsent","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Under the Google [EU User Consent Policy](https://www.google.com/about/company/consentstaging.html), you must make certain disclosures to your users in the European Economic Area (EEA)\nand obtain their consent to use cookies or other local storage, where legally required, and to use personal data\n(such as AdID) to serve ads. This policy reflects the requirements of the EU ePrivacy Directive and the\nGeneral Data Protection Regulation (GDPR).","text":"It is recommended that you determine the status of a user's consent at every app launch. The user consent status is held\non the device until a condition changes which requires the user to consent again, such as a change in publishers.\n\nFor more information, see [here](https://developers.google.com/admob/android/eu-consent#delay_app_measurement_optional).\n"},"children":[{"id":141,"name":"addTestDevices","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":142,"name":"addTestDevices","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"If using a real device to test, ensure the device ID is provided to the Google AdMob SDK so any mock debug locations\ncan take effect.","text":"Emulators are automatically whitelisted and require no action.\n\nIf you are unsure of how to obtain a device ID, see [react-native-device-info](https://github.com/react-native-community/react-native-device-info).\n"},"parameters":[{"id":143,"name":"deviceIds","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An array of testing device ID.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":482,"character":18}]},{"id":128,"name":"getAdProviders","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":129,"name":"getAdProviders","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a list of ad providers currently in use for the given AdMob App ID.","text":"If requesting consent from the user via your own method, this list of ad providers must be shown to the user\nfor them to accept consent.\n\n#### Example\n\n```js\nimport { AdsConsent } from '@react-native-firebase/admob';\n\nconst providers = await AdsConsent.getAdProviders();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"AdProvider","id":157}}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":371,"character":18}]},{"id":136,"name":"getStatus","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":137,"name":"getStatus","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the current consent status of the user.","text":"> The user consent status may change at any time, therefore don't reuse old values locally and always request the current value at any time consent is required.\n\n#### Example\n\n```js\nimport { AdsConsent } from '@react-native-firebase/admob';\n\nconst status = await AdsConsent.getStatus();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"union","types":[{"type":"reference","name":"AdsConsentStatus.UNKNOWN","id":166},{"type":"reference","name":"AdsConsentStatus.NON_PERSONALIZED","id":167},{"type":"reference","name":"AdsConsentStatus.PERSONALIZED","id":168}]}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":445,"character":13}]},{"id":122,"name":"requestInfoUpdate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":123,"name":"requestInfoUpdate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Requests user consent for a given list of publisher IDs.","text":"The list of publisher IDs can be obtained from the settings panel on the Google AdMob console. If the list of\npublisher IDs has changed since the last time a user provided consent, their consent status will be reset to\n'UNKNOWN' and they must provide consent again.\n\nIf the request fails with the error \"Could not parse Event FE preflight response\", this means the state of your\nGoogle AdMob account is not complete. Ensure you have validated your account and have setup valid payment\ninformation. This error is also thrown when a Publisher ID is invalid.\n\nThe response from this method provides request location and consent status properties.\n\nIf request location is within the EEA or unknown, and the consent status is also unknown, you\nmust request consent via the `showForm()` method or your own means.\n\nIf the consent status is not unknown, the user has already previously provided consent for the current publisher\nscope.\n\n#### Example\n\n```js\nimport { AdsConsent } from '@react-native-firebase/admob';\n\nconst consent = await AdsConsent.requestInfoUpdate(['pub-6189033257628554']);\nconsole.log('User location within EEA or Unknown:', consent.isRequestLocationInEeaOrUnknown);\nconsole.log('User consent status:', consent.status);\n```\n"},"parameters":[{"id":124,"name":"publisherIds","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A list of publisher IDs found on your Google AdMob dashboard.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"AdsConsentInfo","id":154}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":303,"character":21}]},{"id":130,"name":"setDebugGeography","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":131,"name":"setDebugGeography","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the debug geography to locally test consent.","text":"If debugging on an emulator (where location cannot be determined) or outside of the EEA,\nit is possible set your own location to test how your app handles different scenarios.\n\nIf using a real device, ensure you have set it as a test device via `addTestDevice()` otherwise this method will have\nno effect.\n\n#### Example\n\n```js\nimport { AdsConsent, AdsConsentDebugGeography } from '@react-native-firebase/admob';\n\n// Set disabled\nawait AdsConsentDebugGeography.setDebugGeography(AdsConsentDebugGeography.DISABLED);\n\n// Set within EEA\nawait AdsConsentDebugGeography.setDebugGeography(AdsConsentDebugGeography.EEA);\n\n// Set outside EEA\nawait AdsConsentDebugGeography.setDebugGeography(AdsConsentDebugGeography.NOT_EEA);\n```\n"},"parameters":[{"id":132,"name":"geography","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The debug geography location.\n"},"type":{"type":"union","types":[{"type":"reference","name":"AdsConsentDebugGeography.DISABLED","id":162},{"type":"reference","name":"AdsConsentDebugGeography.EEA","id":163},{"type":"reference","name":"AdsConsentDebugGeography.NOT_EEA","id":164}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":399,"character":21}]},{"id":133,"name":"setStatus","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":134,"name":"setStatus","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Manually update the consent status of the user.","text":"This method is used when providing your own means of user consent. If using the Google-rendered form via `showForm()`,\nthe consent status is automatically set and calling this method is not required.\n\nThis method can also be used to reset the consent status, by setting it to `AdsConsentStatus.UNKNOWN`, which may be useful in certain circumstances.\n\n#### Example\n\n```js\nimport { AdsConsent, AdsConsentStatus } from '@react-native-firebase/admob';\n\n// User accepted personalized ads\nawait AdsConsent.setStatus(AdsConsentStatus.PERSONALIZED);\n```\n"},"parameters":[{"id":135,"name":"status","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The user consent status.\n"},"type":{"type":"union","types":[{"type":"reference","name":"AdsConsentStatus.UNKNOWN","id":166},{"type":"reference","name":"AdsConsentStatus.NON_PERSONALIZED","id":167},{"type":"reference","name":"AdsConsentStatus.PERSONALIZED","id":168}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":425,"character":13}]},{"id":138,"name":"setTagForUnderAgeOfConsent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":139,"name":"setTagForUnderAgeOfConsent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"If a publisher is aware that the user is under the age of consent, all ad requests must set TFUA (Tag For Users\nUnder the Age of consent in Europe). This setting takes effect for all future ad requests.","text":"Once the TFUA setting is enabled, the Google-rendered consent form will fail to load. All ad requests that include\nTFUA will be made ineligible for personalized advertising and remarketing. TFUA disables requests to third-party\nad technology providers, such as ad measurement pixels and third-party ad servers.\n\nTo remove TFUA from ad requests, set the value to `false`.\n\n#### Example\n\n```js\nimport { AdsConsent } from '@react-native-firebase/admob';\n\n// User is under age of consent\nawait AdsConsent.setTagForUnderAgeOfConsent(true);\n```\n"},"parameters":[{"id":140,"name":"tag","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The boolean value to tag for under age consent.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":470,"character":30}]},{"id":125,"name":"showForm","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":126,"name":"showForm","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Shows a Google-rendered user consent form.","text":"The Google-rendered consent form is a full-screen configurable form that displays over your app content. The form\nallows the following configuration options:\n\n\n1. Consent to view personalized ads (via `withPersonalizedAds`).\n2. Consent to view non-personalized ads (via `withNonPersonalizedAds`).\n3. Use a paid version of the app instead of viewing ads (via `withAdFree`).\n\nEvery consent form requires a privacy policy URL which outlines the usage of your application.\n\nYou should review the consent text carefully: what appears by default is a message that might be appropriate if\nyou use Google to monetize your app.\n\nIf providing an ad-free version of your app, ensure you handle this once the form has been handled by the user\nvia the `userPrefersAdFree` property. The users preference on consent is automatically forwarded onto the Google\nMobile SDKs and saved.\n\nIf the user is outside of the EEA, the request form will error.\n\n#### Example\n\n```js\nimport { AdsConsent, AdsConsentStatus } from '@react-native-firebase/admob';\n\nasync function requestConsent() {\n  const consent = await AdsConsent.requestInfoUpdate(['pub-6189033257628554']);\n\n  // Check if user requires consent\n  if (consent.isRequestLocationInEeaOrUnknown && consent.status === AdsConsentStatus.UNKNOWN) {\n    // Show a Google-rendered form\n    const result = await AdsConsent.showForm({\n      privacyPolicy: 'https://invertase.io/privacy-policy',\n      withPersonalizedAds: true,\n      withNonPersonalizedAds: true,\n      withAdFree: true,\n    });\n\n    console.log('User accepted personalized: ', result.status === AdsConsentStatus.PERSONALIZED);\n    console.log('User accepted non-personalized: ', result.status === AdsConsentStatus.NON_PERSONALIZED);\n    console.log('User prefers Ad Free version of app: ', result.userPrefersAdFree);\n  }\n}\n\n```\n"},"parameters":[{"id":127,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An AdsConsentFormOptions interface to control the Google-rendered form.\n"},"type":{"type":"reference","name":"AdsConsentFormOptions","id":144}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"AdsConsentFormResult","id":151}]}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":355,"character":12}]}],"groups":[{"title":"Methods","kind":2048,"children":[141,128,136,122,130,133,138,125]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":271,"character":29}]},{"id":161,"name":"AdsConsentDebugGeography","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"AdsConsentDebugGeography interface.","text":"Used to set a mock location when testing the `AdsConsent` helper.\n"},"children":[{"id":162,"name":"DISABLED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Disable any debug geography."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":601,"character":12}],"type":{"type":"unknown","name":"0"}},{"id":163,"name":"EEA","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Sets the location to within the EEA."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":606,"character":7}],"type":{"type":"unknown","name":"1"}},{"id":164,"name":"NOT_EEA","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Sets the location to outside of the EEA."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":611,"character":11}],"type":{"type":"unknown","name":"2"}}],"groups":[{"title":"Properties","kind":1024,"children":[162,163,164]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":597,"character":43}]},{"id":144,"name":"AdsConsentFormOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The options used to show on the Google-rendered consent form. At least one of `withAdFree`, `withPersonalizedAds` and `WithNonPersonalizedAds` needs to be set to `true`."},"children":[{"id":145,"name":"privacyPolicy","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A fully formed HTTP or HTTPS privacy policy URL for your application.","text":"Users will have the option to visit this web page before consenting to ads.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":494,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":148,"name":"withAdFree","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Set to `true` to provide the option for the user to choose an ad-free version of your app, defaults to `false`.","text":"If the user chooses this option, you must handle it as required (e.g. navigating to a paid version of the app,\nor a subscribe view).\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":512,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":147,"name":"withNonPersonalizedAds","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Set to `true` to provide the option for the user to accept being shown non-personalized ads, defaults to `false`."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":504,"character":26}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":146,"name":"withPersonalizedAds","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Set to `true` to provide the option for the user to accept being shown personalized ads, defaults to `false`."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":499,"character":23}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[145,148,147,146]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":488,"character":40}]},{"id":151,"name":"AdsConsentFormResult","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The result of a Google-rendered consent form."},"children":[{"id":152,"name":"status","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The consent status of the user after closing the consent form.","text":"- UNKNOWN: The form was unable to determine the users consent status.\n- NON_PERSONALIZED: The user has accepted non-personalized ads.\n- PERSONALIZED: The user has accepted personalized ads.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":539,"character":10}],"type":{"type":"union","types":[{"type":"reference","name":"AdsConsentStatus.UNKNOWN","id":166},{"type":"reference","name":"AdsConsentStatus.NON_PERSONALIZED","id":167},{"type":"reference","name":"AdsConsentStatus.PERSONALIZED","id":168}]}},{"id":153,"name":"userPrefersAdFree","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If `true`, the user requested an ad-free version of your application."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":547,"character":21}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[152,153]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":531,"character":39}]},{"id":154,"name":"AdsConsentInfo","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The result of requesting info about a users consent status."},"children":[{"id":156,"name":"isRequestLocationInEeaOrUnknown","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If `true` the user is within the EEA or their location could not be determined."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":569,"character":35}],"type":{"type":"intrinsic","name":"boolean"}},{"id":155,"name":"status","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The consent status of the user.","text":"- UNKNOWN: The consent status is unknown and the user must provide consent to show ads if they are within the EEA or location is also unknown.\n- NON_PERSONALIZED: The user has accepted non-personalized ads.\n- PERSONALIZED: The user has accepted personalized ads.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":561,"character":10}],"type":{"type":"union","types":[{"type":"reference","name":"AdsConsentStatus.UNKNOWN","id":166},{"type":"reference","name":"AdsConsentStatus.NON_PERSONALIZED","id":167},{"type":"reference","name":"AdsConsentStatus.PERSONALIZED","id":168}]}}],"groups":[{"title":"Properties","kind":1024,"children":[156,155]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":553,"character":33}]},{"id":165,"name":"AdsConsentStatus","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"AdsConsentStatus interface."},"children":[{"id":167,"name":"NON_PERSONALIZED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The user has accepted non-personalized ads."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":626,"character":20}],"type":{"type":"unknown","name":"1"}},{"id":168,"name":"PERSONALIZED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The user has accepted personalized ads."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":631,"character":16}],"type":{"type":"unknown","name":"2"}},{"id":166,"name":"UNKNOWN","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The consent status is unknown and the user must provide consent to show ads if they are within the EEA or location is also unknown."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":621,"character":11}],"type":{"type":"unknown","name":"0"}}],"groups":[{"title":"Properties","kind":1024,"children":[167,168,166]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":617,"character":35}]},{"id":234,"name":"BannerAd","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An interface for a Banner advert component.","text":"#### Example\n\nThe `BannerAd` interface is exposed as a React component, allowing you to integrate ads within your existing React\nNative code base. The component itself is isolated, meaning any standard `View` props (e.g. `style`) are not\nforwarded on. It is recommended you wrap the `BannerAd` within your own `View` if you wish to apply custom props for use-cases\nsuch as positioning.\n\n```js\nimport { BannerAd, BannerAdSize, TestIds } from '@react-native-firebase/admob';\n\nfunction HomeScreen() {\n  return (\n    <BannerAd\n      unitId={TestIds.BANNER}\n      size={BannerAdSize.FULL_BANNER}\n      requestOptions={{\n        requestNonPersonalizedAdsOnly: true,\n      }}\n      onAdLoaded={() => {\n        console.log('Advert loaded');\n      }}\n      onAdFailedToLoad={(error) => {\n        console.error('Advert failed to load: ', error);\n      }}\n    />\n  );\n}\n```\n"},"children":[{"id":241,"name":"onAdClosed","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Called when the user is about to return to the app after tapping on an ad."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1121,"character":14}],"type":{"type":"reference","name":"Function"}},{"id":239,"name":"onAdFailedToLoad","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"When an ad has failed to load. Callback contains an Error."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1111,"character":20}],"type":{"type":"reference","name":"Function"}},{"id":242,"name":"onAdLeftApplication","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Called when the user has left the application (e.g. clicking an advert)."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1126,"character":23}],"type":{"type":"reference","name":"Function"}},{"id":238,"name":"onAdLoaded","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"When an ad has finished loading."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1106,"character":14}],"type":{"type":"reference","name":"Function"}},{"id":240,"name":"onAdOpened","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The ad is now visible to the user."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1116,"character":14}],"type":{"type":"reference","name":"Function"}},{"id":237,"name":"requestOptions","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The request options for this banner."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1101,"character":18}],"type":{"type":"reference","name":"RequestOptions","id":169}},{"id":236,"name":"size","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The size of the banner. Can be a predefined size via `BannerAdSize` or custom dimensions, e.g. `300x200`.","text":"Inventory must be available for the banner size specified, otherwise a no-fill error will be sent to `onAdFailedToLoad`.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1096,"character":8}],"type":{"type":"union","types":[{"type":"reference","name":"BannerAdSize","id":108},{"type":"intrinsic","name":"string"}]}},{"id":235,"name":"unitId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The AdMob unit ID for the banner."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1089,"character":10}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[241,239,242,238,240,237,236,235]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1085,"character":27}]},{"id":108,"name":"BannerAdSize","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Used to sets the size of an Advert."},"children":[{"id":109,"name":"BANNER","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels)."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":213,"character":10}],"type":{"type":"stringLiteral","value":"BANNER"}},{"id":115,"name":"FLUID","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A dynamically sized banner that matches its parent's width and expands/contracts its height to match the ad's content after loading completes."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":243,"character":9}],"type":{"type":"stringLiteral","value":"FLUID"}},{"id":110,"name":"FULL_BANNER","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels)."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":218,"character":15}],"type":{"type":"stringLiteral","value":"FULL_BANNER"}},{"id":111,"name":"LARGE_BANNER","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Large banner ad size (320x100 density-independent pixels)."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":223,"character":16}],"type":{"type":"stringLiteral","value":"LARGE_BANNER"}},{"id":112,"name":"LEADERBOARD","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels)."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":228,"character":15}],"type":{"type":"stringLiteral","value":"LEADERBOARD"}},{"id":113,"name":"MEDIUM_RECTANGLE","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent pixels)."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":233,"character":20}],"type":{"type":"stringLiteral","value":"MEDIUM_RECTANGLE"}},{"id":114,"name":"SMART_BANNER","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A dynamically sized banner that is full-width and auto-height."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":238,"character":16}],"type":{"type":"stringLiteral","value":"SMART_BANNER"}},{"id":116,"name":"WIDE_SKYSCRAPER","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"IAB wide skyscraper ad size (160x600 density-independent pixels). This size is currently not supported by the Google Mobile Ads network; this is intended for mediation ad networks only."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":248,"character":19}],"type":{"type":"stringLiteral","value":"WIDE_SKYSCRAPER"}}],"groups":[{"title":"Properties","kind":1024,"children":[109,115,110,111,112,113,114,116]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":209,"character":31}]},{"id":185,"name":"MaxAdContentRating","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The MaxAdContentRating interface used when setting global advert request options."},"children":[{"id":186,"name":"G","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"\"General audiences.\" Content suitable for all audiences, including families and children."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":784,"character":5}],"type":{"type":"stringLiteral","value":"G"}},{"id":189,"name":"MA","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"\"Mature audiences.\" Content suitable only for mature audiences; includes topics such as alcohol, gambling, sexual content, and weapons."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":799,"character":6}],"type":{"type":"stringLiteral","value":"MA"}},{"id":187,"name":"PG","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"\"Parental guidance.\" Content suitable for most audiences with parental guidance, including topics like non-realistic, cartoonish violence."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":789,"character":6}],"type":{"type":"stringLiteral","value":"PG"}},{"id":188,"name":"T","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"T: \"Teen.\" Content suitable for teen and older audiences, including topics such as general health, social networks, scary imagery, and fight sports."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":794,"character":5}],"type":{"type":"stringLiteral","value":"T"}}],"groups":[{"title":"Properties","kind":1024,"children":[186,189,187,188]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":780,"character":37}]},{"id":181,"name":"RequestConfiguration","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The `RequestConfiguration` used when setting global ad settings via `setRequestConfiguration`."},"children":[{"id":182,"name":"maxAdContentRating","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The maximum ad content rating for all ads.  AdMob ads returns ads at or below the specified level.","text":"Ratings are based on the [digital content label classifications](https://support.google.com/admob/answer/7562142).\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":750,"character":22}],"type":{"type":"union","types":[{"type":"reference","name":"MaxAdContentRating.G","id":186},{"type":"reference","name":"MaxAdContentRating.PG","id":187},{"type":"reference","name":"MaxAdContentRating.T","id":188},{"type":"reference","name":"MaxAdContentRating.MA","id":189}]}},{"id":183,"name":"tagForChildDirectedTreatment","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If `true`, indicates that you want your content treated as child-directed for purposes of COPPA.","text":"For purposes of the [Children's Online Privacy Protection Act (COPPA)](http://business.ftc.gov/privacy-and-security/children%27s-privacy),\nthere is a setting called \"tag for child-directed treatment\". By setting this tag, you certify that this notification\nis accurate and you are authorized to act on behalf of the owner of the app. You understand that abuse of this\nsetting may result in termination of your Google account.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":764,"character":32}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":184,"name":"tagForUnderAgeOfConsent","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If `true`, indicates that you want the ad request to be handled in a manner suitable for users under the age of consent.","text":"You can mark your ad requests to receive treatment for users in the European Economic Area (EEA) under the age of consent.\nThis feature is designed to help facilitate compliance with the [General Data Protection Regulation (GDPR)](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:32016R0679).\n\nSee the [Google Mobile SDK docs](https://developers.google.com/admob/android/targeting#ad_content_filtering) for more information.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":774,"character":27}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[182,183,184]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":744,"character":39}]},{"id":169,"name":"RequestOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The `RequestOptions` interface. Used when passing additional request options before an advert is loaded."},"children":[{"id":177,"name":"contentUrl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets a content URL for targeting purposes.","text":"Max length of 512.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":698,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":175,"name":"keywords","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An array of keywords to be sent when loading the ad.","text":"Setting keywords helps deliver more specific ads to a user based on the keywords.\n\n#### Example\n\n```js\nawait Interstitial.request('ca-app-pub-3940256099942544/1033173712', {\n  keywords: ['fashion', 'clothing'],\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":678,"character":12}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":178,"name":"location","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The latitude and longitude location of the user.","text":"Ensure your app requests location permissions from the user.\n\n#### Example\n\n```js\nawait Interstitial.request('ca-app-pub-3940256099942544/1033173712', {\n  location: [53.481073, -2.237074],\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":713,"character":12}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":179,"name":"locationAccuracy","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the location accuracy if the location is set, in meters.","text":"This option is only applied to iOS devices. On Android, this option has no effect.\n","tags":[{"tag":"ios","text":"\n"}]},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":722,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":171,"name":"networkExtras","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Attaches additional properties to an ad request for direct campaign delivery.","text":"Takes an array of string key/value pairs.\n\n#### Example\n\nAttaches `?campaign=abc&user=123` to the ad request:\n\n```js\nawait Interstitial.request('ca-app-pub-3940256099942544/1033173712', {\n  networkExtras: {\n    campaign: 'abc',\n    user: '123',\n  },\n});\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":663,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":172,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":173,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":174,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}]}}]}},{"id":180,"name":"requestAgent","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the request agent string to identify the ad request's origin. Third party libraries that reference the Mobile\nAds SDK should call this method to denote the platform from which the ad request originated. For example, if a\nthird party ad network called \"CoolAds network\" mediates requests to the Mobile Ads SDK, it should call this\nmethod with \"CoolAds\".","text":"#### Example\n\n```js\nawait Interstitial.request('ca-app-pub-3940256099942544/1033173712', {\n  requestAgent: 'CoolAds',\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":738,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":170,"name":"requestNonPersonalizedAdsOnly","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If `true` only non-personalized ads will be loaded.","text":"Google serves personalized ads by default. This option must be `true` if users who are within the EEA have only\ngiven consent to non-personalized ads.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":644,"character":33}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":176,"name":"testDevices","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An array of test device IDs to whitelist.","text":"If using an emulator, set the device ID to `EMULATOR`.\n\n```js\nawait Interstitial.request('ca-app-pub-3940256099942544/1033173712', {\n  testDevices: ['EMULATOR'],\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":691,"character":15}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"groups":[{"title":"Properties","kind":1024,"children":[177,175,178,179,171,180,170,176]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":637,"character":33}]},{"id":105,"name":"RewardedAdEventType","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Ad event types specially for `RewardedAd`."},"children":[{"id":107,"name":"EARNED_REWARD","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An event fired when the user earned the reward for the video. If the user does not earn a reward,\nthe `AdEventType.CLOSED` event will be fired with no rewarded event.","text":"The reward contains a `type` and `amount`.\n\n#### Example\n\n```js\nimport { RewardedAdEventType } from '@react-native-firebase/admob';\n\nrewardedAd.onAdEvent((type, error, data) => {\n  if (type === RewardedAdEventType.EARNED_REWARD) {\n    console.log(`User earned ${data.amount} ${data.type}`);\n    // E.g. \"User earned 50 coins\"\n  }\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":203,"character":17}],"type":{"type":"stringLiteral","value":"rewarded_earned_reward"}},{"id":106,"name":"LOADED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An event fired when a rewarded ad has loaded.","text":"This type differs from `AdEventType.LOADED` as when a rewarded ad is loaded,\nan additional data payload is provided to the event handler containing the ad reward\n(assuming the user earns the reward).\n\nThe reward contains a `type` and `amount`.\n\n#### Example\n\n```js\nimport { RewardedAdEventType } from '@react-native-firebase/admob';\n\nrewardedAd.onAdEvent((type, error, data) => {\n  if (type === RewardedAdEventType.LOADED) {\n    console.log(`Rewarded Ad loaded with ${data.amount} ${data.type} as reward`);\n    // E.g. \"Rewarded Ad loaded with 50 coins as reward\"\n    rewardedAd.show();\n  }\n});\n```\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":182,"character":10}],"type":{"type":"stringLiteral","value":"rewarded_loaded"}}],"groups":[{"title":"Properties","kind":1024,"children":[107,106]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":158,"character":38}]},{"id":190,"name":"RewardedAdReward","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `RewardedAdReward` returned from rewarded ads."},"children":[{"id":192,"name":"amount","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The number value of the reward, e.g. 10"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":814,"character":10}],"type":{"type":"intrinsic","name":"number"}},{"id":191,"name":"type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The reward name, e.g. 'coins', 'diamonds'."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":809,"character":8}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[192,191]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":805,"character":35}]},{"id":90,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"firebase.admob.X"},"children":[{"id":94,"name":"AdEventType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"AdEventType enum."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":75,"character":15}],"type":{"type":"reference","name":"AdEventType","id":98}},{"id":92,"name":"AdsConsentDebugGeography","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"AdsConsentDebugGeography interface."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":65,"character":28}],"type":{"type":"reference","name":"AdsConsentDebugGeography","id":161}},{"id":91,"name":"AdsConsentStatus","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"AdsConsentStatus interface."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":60,"character":20}],"type":{"type":"reference","name":"AdsConsentStatus","id":165}},{"id":97,"name":"BannerAdSize","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Used to sets the size of an Advert."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":90,"character":16}],"type":{"type":"reference","name":"BannerAdSize","id":108}},{"id":93,"name":"MaxAdContentRating","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"AdsConsentDebugGeography interface."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":70,"character":22}],"type":{"type":"reference","name":"MaxAdContentRating","id":185}},{"id":95,"name":"RewardedAdEventType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"RewardedAdEventType enum."},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":80,"character":23}],"type":{"type":"reference","name":"RewardedAdEventType","id":105}},{"id":96,"name":"TestIds","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"TestIds interface"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":85,"character":11}],"type":{"type":"reference","name":"TestIds","id":117}}],"groups":[{"title":"Properties","kind":1024,"children":[94,92,91,97,93,95,96]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":56,"character":26}]},{"id":117,"name":"TestIds","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Ad Unit IDs used for testing purposes. These should not be used in production apps."},"children":[{"id":118,"name":"BANNER","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":255,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":119,"name":"INTERSTITIAL","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":256,"character":16}],"type":{"type":"intrinsic","name":"string"}},{"id":120,"name":"REWARDED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":257,"character":12}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[118,119,120]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":254,"character":26}]},{"id":248,"name":"AdEventListener","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"A callback interface for all ad events.","tags":[{"tag":"param","text":"The event type, e.g. `AdEventType.LOADED`.","param":"type"},{"tag":"param","text":"An optional JavaScript Error containing the error code and message.","param":"error"},{"tag":"param","text":"Optional data for the event, e.g. reward type and amount\n","param":"data"}]},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":824,"character":29}],"type":{"type":"reflection","declaration":{"id":249,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":250,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":251,"name":"type","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"reference","name":"AdEventType.LOADED","id":99},{"type":"reference","name":"AdEventType.ERROR","id":100},{"type":"reference","name":"AdEventType.OPENED","id":101},{"type":"reference","name":"AdEventType.CLICKED","id":102},{"type":"reference","name":"AdEventType.LEFT_APPLICATION","id":103},{"type":"reference","name":"AdEventType.CLOSED","id":104},{"type":"reference","name":"RewardedAdEventType.LOADED","id":106},{"type":"reference","name":"RewardedAdEventType.EARNED_REWARD","id":107}]}},{"id":252,"name":"error","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"Error","id":10}},{"id":253,"name":"data","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"any"},{"type":"reference","name":"RewardedAdReward","id":190}]}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":824,"character":31}]}}}],"groups":[{"title":"Classes","kind":128,"children":[204,193,243,219]},{"title":"Interfaces","kind":256,"children":[98,157,149,121,161,144,151,154,165,234,108,185,181,169,105,190,90,117]},{"title":"Type aliases","kind":4194304,"children":[248]}],"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":50,"character":35}]},{"id":275,"name":"FirebaseAnalyticsTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Analytics package for React Native.","text":"#### Example: Access the firebase export from the `analytics` package:\n\n```js\nimport { firebase } from '@react-native-firebase/analytics';\n\n// firebase.analytics().X\n```\n\n#### Example: Using the default export from the `analytics` package:\n\n```js\nimport analytics from '@react-native-firebase/analytics';\n\n// analytics().X\n```\n\n#### Example: Using the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/analytics';\n\n// firebase.analytics().X\n```\n","tags":[{"tag":"firebase","text":"analytics\n"}]},"children":[{"id":428,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Analytics service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Analytics service for the default app:\n\n```js\nconst defaultAppAnalytics = firebase.analytics();\n```\n"},"children":[{"id":547,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":464,"name":"logAddPaymentInfo","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":465,"name":"logAddPaymentInfo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Add Payment Info event. This event signifies that a user has submitted their payment information to your app.","text":"Logged event name: `add_payment_info`\n\n#### Example\n\n```js\nawait firebase.analytics().logAddPaymentInfo();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":809,"character":21}]},{"id":466,"name":"logAddToCart","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":467,"name":"logAddToCart","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"E-Commerce Add To Cart event. This event signifies that an item was added to a cart for purchase.\nAdd this event to a funnel with {@link analytics#logEcommercePurchase} to gauge the effectiveness of your checkout process.","text":"If you supply the VALUE parameter, you must also supply the CURRENCY parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `add_to_cart`\n\n#### Example\n\n```js\nawait firebase.analytics().logAddToCart({\n  item_id: 'abcd',\n  item_name: 't-shirt 1',\n  item_category: 'shirts',\n  quantity: 2,\n});\n```\n"},"parameters":[{"id":468,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.AddToCartEventParameters}.\n"},"type":{"type":"reference","name":"AddToCartEventParameters","id":276}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":832,"character":16}]},{"id":469,"name":"logAddToWishlist","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":470,"name":"logAddToWishlist","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"E-Commerce Add To Wishlist event. This event signifies that an item was added to a wishlist.\nUse this event to identify popular gift items in your app.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `add_to_wishlist`\n\n#### Example\n\n```js\nawait firebase.analytics().logAddToWishlist({\n  item_id: 'abcd',\n  item_name: 't-shirt 1',\n  item_category: 'shirts',\n  quantity: 2,\n});\n```\n"},"parameters":[{"id":471,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.AddToWishlistEventParameters}.\n"},"type":{"type":"reference","name":"AddToWishlistEventParameters","id":289}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":855,"character":20}]},{"id":472,"name":"logAppOpen","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":473,"name":"logAppOpen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"App Open event. By logging this event when an App is moved to the foreground, developers can\nunderstand how often users leave and return during the course of a Session. Although Sessions\nare automatically reported, this event can provide further clarification around the continuous\nengagement of app-users.","text":"Logged event name: `app_open`\n\n#### Example\n\n```js\nawait firebase.analytics().logAppOpen();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":871,"character":14}]},{"id":474,"name":"logBeginCheckout","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":475,"name":"logBeginCheckout","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"E-Commerce Begin Checkout event. This event signifies that a user has begun the process of\nchecking out. Add this event to a funnel with your {@link analytics#logEcommercePurchase} event to gauge the\neffectiveness of your checkout process.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `begin_checkout`\n\n#### Example\n\n```js\nawait firebase.analytics().logBeginCheckout({\n travel_class: 'business',\n});\n```\n"},"parameters":[{"id":476,"name":"params","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"See {@link analytics.BeginCheckoutEventParameters}.\n"},"type":{"type":"reference","name":"BeginCheckoutEventParameters","id":298}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":892,"character":20}]},{"id":477,"name":"logCampaignDetails","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":478,"name":"logCampaignDetails","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Log this event to supply the referral details of a re-engagement campaign.","text":"Logged event name: `campaign_details`\n\n#### Example\n\n```js\nawait firebase.analytics().logCampaignDetails({\n  source: 'email',\n  medium: 'cta_button',\n  campaign: 'newsletter',\n});\n```\n"},"parameters":[{"id":479,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.CampaignDetailsEventParameters}.\n"},"type":{"type":"reference","name":"CampaignDetailsEventParameters","id":310}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":911,"character":22}]},{"id":480,"name":"logEarnVirtualCurrency","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":481,"name":"logEarnVirtualCurrency","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Earn Virtual Currency event. This event tracks the awarding of virtual currency in your app. Log this along with\n{@link analytics.logSpendVirtualCurrency} to better understand your virtual economy.","text":"Logged event name: `earn_virtual_currency`\n\n#### Example\n\n```js\nawait firebase.analytics().logEarnVirtualCurrency({\n  virtual_currency_name: 'coins',\n  value: 100,\n});\n```\n"},"parameters":[{"id":482,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.EarnVirtualCurrencyEventParameters}.\n"},"type":{"type":"reference","name":"EarnVirtualCurrencyEventParameters","id":318}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":930,"character":26}]},{"id":483,"name":"logEcommercePurchase","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":484,"name":"logEcommercePurchase","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"E-Commerce Purchase event. This event signifies that an item was purchased by a user. This is\ndifferent from the in-app purchase event, which is reported automatically for Google Play-based apps.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `ecommerce_purchase`\n\n#### Example\n\n```js\nawait firebase.analytics().logEcommercePurchase({\n  coupon: 'BOGOFF',\n});\n```\n"},"parameters":[{"id":485,"name":"params","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"See {@link analytics.EcommercePurchaseEventParameters}.\n"},"type":{"type":"reference","name":"EcommercePurchaseEventParameters","id":321}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":950,"character":24}]},{"id":429,"name":"logEvent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":430,"name":"logEvent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Log a custom event with optional params.","text":"#### Example\n\n```js\nawait firebase.analytics().logEvent('product_view', {\n  id: '1234',\n});\n```\n\n> 100 characters is the maximum length for param key names.\n"},"parameters":[{"id":431,"name":"name","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Event name must not conflict with any Reserved Events."},"type":{"type":"intrinsic","name":"string"}},{"id":432,"name":"params","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Parameters to be sent and displayed with the event.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":433,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":434,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":435,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}]}}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":673,"character":12}]},{"id":486,"name":"logGenerateLead","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":487,"name":"logGenerateLead","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generate Lead event. Log this event when a lead has been generated in the app to understand\nthe efficacy of your install and re-engagement campaigns.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `generate_lead`\n\n#### Example\n\n```js\nawait firebase.analytics().logGenerateLead({\n  currency: 'USD',\n  value: 123,\n});\n```\n"},"parameters":[{"id":488,"name":"params","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"See {@link analytics.GenerateLeadEventParameters}.\n"},"type":{"type":"reference","name":"GenerateLeadEventParameters","id":337}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":971,"character":19}]},{"id":489,"name":"logJoinGroup","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":490,"name":"logJoinGroup","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Join Group event. Log this event when a user joins a group such as a guild, team or family.\nUse this event to analyze how popular certain groups or social features are in your app","text":"Logged event name: `join_group`\n\n#### Example\n\n```js\nawait firebase.analytics().logJoinGroup({\n  group_id: '12345',\n});\n```\n"},"parameters":[{"id":491,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.JoinGroupEventParameters}.\n"},"type":{"type":"reference","name":"JoinGroupEventParameters","id":340}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":989,"character":16}]},{"id":492,"name":"logLevelEnd","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":493,"name":"logLevelEnd","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Level End event.","text":"Logged event name: `level_end`\n\n#### Example\n\n```js\nawait firebase.analytics().logLevelEnd({\n  level: 12,\n  success: 'true'\n});\n```\n"},"parameters":[{"id":494,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.LevelEndEventParameters}.\n"},"type":{"type":"reference","name":"LevelEndEventParameters","id":342}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1007,"character":15}]},{"id":495,"name":"logLevelStart","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":496,"name":"logLevelStart","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Level Start event.","text":"Logged event name: `level_start`\n\n#### Example\n\n```js\nawait firebase.analytics().logLevelStart({\n  level: 12,\n});\n```\n"},"parameters":[{"id":497,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.LevelStartEventParameters}.\n"},"type":{"type":"reference","name":"LevelStartEventParameters","id":345}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1024,"character":17}]},{"id":498,"name":"logLevelUp","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":499,"name":"logLevelUp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Level Up event. This event signifies that a player has leveled up in your gaming app.\nIt can help you gauge the level distribution of your userbase and help you identify certain levels that are difficult to pass.","text":"Logged event name: `level_up`\n\n#### Example\n\n```js\nawait firebase.analytics().logLevelUp({\n  level: 12,\n  character: 'Snake',\n});\n```\n"},"parameters":[{"id":500,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.LevelUpEventParameters}.\n"},"type":{"type":"reference","name":"LevelUpEventParameters","id":347}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1043,"character":14}]},{"id":501,"name":"logLogin","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":502,"name":"logLogin","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Login event. Apps with a login feature can report this event to signify that a user has logged in.","text":"Logged event name: `login`\n\n#### Example\n\n```js\nawait firebase.analytics().logLogin({\n  method: 'facebook.com',\n});\n```\n"},"parameters":[{"id":503,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.LoginEventParameters}.\n"},"type":{"type":"reference","name":"LoginEventParameters","id":350}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1060,"character":12}]},{"id":504,"name":"logPresentOffer","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":505,"name":"logPresentOffer","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Present Offer event. This event signifies that the app has presented a purchase offer to a user.\nAdd this event to a funnel with the {@link analytics#logAddToCart} and {@link analytics#logEcommercePurchase}\nto gauge your conversion process.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `present_offer`\n\n#### Example\n\n```js\nawait firebase.analytics().logPresentOffer({\n  item_id: 'abcd',\n  item_name: 't-shirt',\n  item_category: 'shirts',\n  quantity: 1,\n  price: 9.99,\n});\n```\n"},"parameters":[{"id":506,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.PresentOfferEventParameters}.\n"},"type":{"type":"reference","name":"PresentOfferEventParameters","id":356}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1085,"character":19}]},{"id":507,"name":"logPurchaseRefund","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":508,"name":"logPurchaseRefund","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"E-Commerce Purchase Refund event. This event signifies that an item purchase was refunded.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `purchase_refund`\n\n#### Example\n\n```js\nawait firebase.analytics().logPurchaseRefund({\n transaction_id: 'abcd',\n});\n```\n"},"parameters":[{"id":509,"name":"params","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"See {@link analytics.PurchaseRefundEventParameters}.\n"},"type":{"type":"reference","name":"PurchaseRefundEventParameters","id":360}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1104,"character":21}]},{"id":510,"name":"logRemoveFromCart","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":511,"name":"logRemoveFromCart","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Remove from cart event.","text":"Logged event name: `remove_from_cart`\n\n#### Example\n\n```js\nawait firebase.analytics().logRemoveFromCart({\n  item_id: 'abcd',\n  item_name: 't-shirt',\n  item_category: 'shirts',\n});\n```\n"},"parameters":[{"id":512,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.RemoveFromCartEventParameters}.\n"},"type":{"type":"reference","name":"RemoveFromCartEventParameters","id":364}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1123,"character":21}]},{"id":513,"name":"logSearch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":514,"name":"logSearch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Search event. Apps that support search features can use this event to contextualize search\noperations by supplying the appropriate, corresponding parameters. This event can help you\nidentify the most popular content in your app.","text":"Logged event name: `search`\n\n#### Example\n\n```js\nawait firebase.analytics().logSearch({\n search_term: 't-shirts',\n});\n```\n"},"parameters":[{"id":515,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.SearchEventParameters}.\n"},"type":{"type":"reference","name":"SearchEventParameters","id":377}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1142,"character":13}]},{"id":516,"name":"logSelectContent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":517,"name":"logSelectContent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Select Content event. This general purpose event signifies that a user has selected some\ncontent of a certain type in an app. The content can be any object in your app. This event\ncan help you identify popular content and categories of content in your app.","text":"Logged event name: `select_content`\n\n#### Example\n\n```js\nawait firebase.analytics().logSelectContent({\n content_type: 'clothing',\n item_id: 'abcd',\n});\n```\n"},"parameters":[{"id":518,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.SelectContentEventParameters}.\n"},"type":{"type":"reference","name":"SelectContentEventParameters","id":387}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1162,"character":20}]},{"id":519,"name":"logSetCheckoutOption","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":520,"name":"logSetCheckoutOption","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Set checkout option event.","text":"Logged event name: `set_checkout_option`\n\n#### Example\n\n```js\nawait firebase.analytics().logSetCheckoutOption({\n  checkout_step: 2,\n  checkout_option: 'false',\n});\n```\n"},"parameters":[{"id":521,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.SetCheckoutOptionEventParameters}.\n"},"type":{"type":"reference","name":"SetCheckoutOptionEventParameters","id":390}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1180,"character":24}]},{"id":522,"name":"logShare","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":523,"name":"logShare","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Share event. Apps with social features can log the Share event to identify the most viral content.","text":"Logged event name: `share`\n\n#### Example\n\n```js\nawait firebase.analytics().logShare({\n  content_type: 't-shirts',\n  item_id: '12345',\n  method: 'twitter.com',\n});\n```\n"},"parameters":[{"id":524,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.ShareEventParameters}.\n"},"type":{"type":"reference","name":"ShareEventParameters","id":393}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1199,"character":12}]},{"id":525,"name":"logSignUp","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":526,"name":"logSignUp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sign Up event. This event indicates that a user has signed up for an account in your app.\nThe parameter signifies the method by which the user signed up. Use this event to understand\nthe different behaviors between logged in and logged out users.","text":"Logged event name: `sign_up`\n\n#### Example\n\n```js\nawait firebase.analytics().logSignUp({\n  method: 'facebook.com',\n});\n```\n"},"parameters":[{"id":527,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.SignUpEventParameters}.\n"},"type":{"type":"reference","name":"SignUpEventParameters","id":396}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1218,"character":13}]},{"id":528,"name":"logSpendVirtualCurrency","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":529,"name":"logSpendVirtualCurrency","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Spend Virtual Currency event. This event tracks the sale of virtual goods in your app and can\nhelp you identify which virtual goods are the most popular objects of purchase.","text":"Logged event name: `spend_virtual_currency`\n\n#### Example\n\n```js\nawait firebase.analytics().logSpendVirtualCurrency({\n  item_name: 'battle_pass',\n  virtual_currency_name: 'coins',\n  value: 100,\n});\n```\n"},"parameters":[{"id":530,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.SpendVirtualCurrencyEventParameters}.\n"},"type":{"type":"reference","name":"SpendVirtualCurrencyEventParameters","id":398}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1238,"character":27}]},{"id":531,"name":"logTutorialBegin","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":532,"name":"logTutorialBegin","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Tutorial Begin event. This event signifies the start of the on-boarding process in your app.\nUse this in a funnel with {@link analytics#logTutorialComplete} to understand how many users\ncomplete this process and move on to the full app experience.","text":"Logged event name: `tutorial_begin`\n\n#### Example\n\n```js\nawait firebase.analytics().logTutorialBegin();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1253,"character":20}]},{"id":533,"name":"logTutorialComplete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":534,"name":"logTutorialComplete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Tutorial End event. Use this event to signify the user's completion of your app's on-boarding process.\nAdd this to a funnel with {@link analytics#logTutorialBegin} to understand how many users\ncomplete this process and move on to the full app experience.","text":"Logged event name: `tutorial_complete`\n\n#### Example\n\n```js\nawait firebase.analytics().logTutorialComplete();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1268,"character":23}]},{"id":535,"name":"logUnlockAchievement","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":536,"name":"logUnlockAchievement","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unlock Achievement event. Log this event when the user has unlocked an achievement in your game.\nSince achievements generally represent the breadth of a gaming experience, this event can help\nyou understand how many users are experiencing all that your game has to offer.","text":"Logged event name: `unlock_achievement`\n\n#### Example\n\n```js\nawait firebase.analytics().logUnlockAchievement({\n  achievement_id: '12345',\n});\n```\n"},"parameters":[{"id":537,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.UnlockAchievementEventParameters}.\n"},"type":{"type":"reference","name":"UnlockAchievementEventParameters","id":402}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1287,"character":24}]},{"id":538,"name":"logViewItem","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":539,"name":"logViewItem","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"View Item event. This event signifies that some content was shown to the user. This content\nmay be a product, a screen or just a simple image or text. Use the appropriate parameters\nto contextualize the event. Use this event to discover the most popular items viewed in your app.","text":"If you supply the `value` parameter, you must also supply the `currency` parameter so that revenue metrics can be computed accurately.\n\nLogged event name: `view_item`\n\n#### Example\n\n```js\nawait firebase.analytics().logViewItem({\n item_id: 'abcd',\n item_name: 't-shirt',\n item_category: 'shirts',\n});\n```\n"},"parameters":[{"id":540,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.ViewItemEventParameters}.\n"},"type":{"type":"reference","name":"ViewItemEventParameters","id":404}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1310,"character":15}]},{"id":541,"name":"logViewItemList","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":542,"name":"logViewItemList","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"View Item List event. Log this event when the user has been presented with a list of items of a certain category.","text":"Logged event name: `view_item_list`\n\n#### Example\n\n```js\nawait firebase.analytics().logViewItemList({\n  item_category: 't-shirts',\n});\n```\n"},"parameters":[{"id":543,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.ViewItemListEventParameters}.\n"},"type":{"type":"reference","name":"ViewItemListEventParameters","id":423}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1327,"character":19}]},{"id":544,"name":"logViewSearchResults","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":545,"name":"logViewSearchResults","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"View Search Results event. Log this event when the user has been presented with the results of a search.","text":"Logged event name: `view_search_results`\n\n#### Example\n\n```js\nawait firebase.analytics().logViewSearchResults({\n  search_term: 'clothing',\n});\n```\n"},"parameters":[{"id":546,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"See {@link analytics.ViewSearchResults}.\n"},"type":{"type":"reference","name":"ViewSearchResults","id":425}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1344,"character":24}]},{"id":462,"name":"resetAnalyticsData","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":463,"name":"resetAnalyticsData","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Clears all analytics data for this instance from the device and resets the app instance ID.","text":"#### Example\n\n```js\nawait firebase.analytics().resetAnalyticsData();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":796,"character":22}]},{"id":436,"name":"setAnalyticsCollectionEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":437,"name":"setAnalyticsCollectionEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"If true, allows the device to collect analytical data and send it to\nFirebase. Useful for GDPR.","text":"#### Example\n\n```js\n// Disable collection\nawait firebase.analytics().setAnalyticsCollectionEnabled(false);\n```\n"},"parameters":[{"id":438,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A boolean value representing whether Analytics collection is enabled or disabled. Analytics collection is enabled by default.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":688,"character":33}]},{"id":439,"name":"setCurrentScreen","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":440,"name":"setCurrentScreen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the current screen name.","text":"#### Example\n\n```js\nawait firebase.analytics().setCurrentScreen('ProductScreen', 'ProductScreen');\n```\n\n> Whilst screenClassOverride is optional, it is recommended it is\nalways sent as your current class name. For example on Android it will always\nshow as 'MainActivity' if you do not specify it.\n"},"parameters":[{"id":441,"name":"screenName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A screen name, e.g. Product."},"type":{"type":"intrinsic","name":"string"}},{"id":442,"name":"screenClassOverride","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"On Android, React Native runs in a single activity called\n'MainActivity'. Setting this parameter overrides the default name shown on logs.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":707,"character":20}]},{"id":443,"name":"setMinimumSessionDuration","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":444,"name":"setMinimumSessionDuration","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the minimum engagement time required before starting a session.","text":"#### Example\n\n```js\n// 20 seconds\nawait firebase.analytics().setMinimumSessionDuration(20000);\n```\n"},"parameters":[{"id":445,"name":"milliseconds","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The default value is 10000 (10 seconds).\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":721,"character":29}]},{"id":446,"name":"setSessionTimeoutDuration","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":447,"name":"setSessionTimeoutDuration","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the duration of inactivity that terminates the current session.","text":"#### Example\n\n```js\n// 20 minutes\nawait firebase.analytics().setMinimumSessionDuration(900000);\n```\n"},"parameters":[{"id":448,"name":"milliseconds","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The default value is 1800000 (30 minutes).\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":735,"character":29}]},{"id":449,"name":"setUserId","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":450,"name":"setUserId","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gives a user a unique identification.","text":"#### Example\n\n```js\n// Set User\nawait firebase.analytics().setUserId('123456789');\n// Remove User\nawait firebase.analytics().setUserId(null);\n```\n"},"parameters":[{"id":451,"name":"id","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Set to null to remove a previously assigned ID from analytics\nevents\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":752,"character":13}]},{"id":456,"name":"setUserProperties","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":457,"name":"setUserProperties","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets multiple key/value pairs of data on the current user. Each Firebase project can have up to 25 uniquely named (case-sensitive) user properties.","text":"#### Example\n\n```js\nawait firebase.analytics().setUserProperties({\n  account_type: 'gold',\n  account_name: 'Gold Badge',\n});\n```\n\n> When you set user properties, be sure to never include personally identifiable information such as names, social security numbers, or email addresses, even in hashed form.\n","tags":[{"tag":"react-native-firebase","text":""}]},"parameters":[{"id":458,"name":"properties","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Set a property value to null to remove it.\n"},"type":{"type":"reflection","declaration":{"id":459,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":460,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":461,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":785,"character":33}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":785,"character":21}]},{"id":452,"name":"setUserProperty","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":453,"name":"setUserProperty","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a key/value pair of data on the current user. Each Firebase project can have up to 25 uniquely named (case-sensitive) user properties.","text":"#### Example\n\n```js\nawait firebase.analytics().setUserProperty('account_type', 'gold');\n```\n"},"parameters":[{"id":454,"name":"name","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A user property identifier."},"type":{"type":"intrinsic","name":"string"}},{"id":455,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Set to null to remove a previously assigned ID from analytics events.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":766,"character":19}]}],"groups":[{"title":"Properties","kind":1024,"children":[547]},{"title":"Methods","kind":2048,"children":[464,466,469,472,474,477,480,483,429,486,489,492,495,498,501,504,507,510,513,516,519,522,525,528,531,533,535,538,541,544,462,436,439,443,446,449,456,452]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":656,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":276,"name":"AddToCartEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":283,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":83,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":286,"name":"destination","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel destination. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":95,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":288,"name":"end_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":103,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":279,"name":"item_category","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item category."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":65,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":277,"name":"item_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":57,"character":11}],"type":{"type":"intrinsic","name":"string"}},{"id":285,"name":"item_location_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Google [Place ID](https://developers.google.com/places/place-id) that corresponds to the associated item (String). Alternatively, you can supply your own custom Location ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":91,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":278,"name":"item_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item name."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":61,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":284,"name":"origin","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel origin. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":87,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":281,"name":"price","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase price."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":73,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":280,"name":"quantity","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Purchase quantity."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":69,"character":12}],"type":{"type":"intrinsic","name":"number"}},{"id":287,"name":"start_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":99,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":282,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":79,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[283,286,288,279,277,285,278,284,281,280,287,282]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":53,"character":43}]},{"id":289,"name":"AddToWishlistEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":296,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":136,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":292,"name":"item_category","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item category."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":118,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":290,"name":"item_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":110,"character":11}],"type":{"type":"intrinsic","name":"string"}},{"id":297,"name":"item_location_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Google [Place ID](https://developers.google.com/places/place-id) that corresponds to the associated item (String). Alternatively, you can supply your own custom Location ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":140,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":291,"name":"item_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item name."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":114,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":294,"name":"price","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase price."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":126,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":293,"name":"quantity","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Purchase quantity."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":122,"character":12}],"type":{"type":"intrinsic","name":"number"}},{"id":295,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":132,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[296,292,290,297,291,294,293,295]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":106,"character":47}]},{"id":298,"name":"BeginCheckoutEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":300,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":153,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":306,"name":"destination","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel destination. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":177,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":308,"name":"end_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":185,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":302,"name":"number_of_nights","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of nights staying at hotel."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":161,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":304,"name":"number_of_passengers","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of passengers traveling."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":169,"character":24}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":303,"name":"number_of_rooms","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of rooms for travel events."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":165,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":305,"name":"origin","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel origin. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":173,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":307,"name":"start_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":181,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":301,"name":"transaction_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A single ID for a ecommerce group transaction."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":157,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":309,"name":"travel_class","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Travel class. E.g. `business`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":189,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":299,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":149,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[300,306,308,302,304,303,305,307,301,309,299]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":143,"character":47}]},{"id":310,"name":"CampaignDetailsEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":316,"name":"aclid","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A campaign detail click ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":216,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":313,"name":"campaign","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":" Used for keyword analysis to identify a specific product promotion or strategic campaign."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":204,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":315,"name":"content","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Used for A/B testing and content-targeted ads to differentiate ads or links that point to the same URL."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":212,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":317,"name":"cp1","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":217,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":312,"name":"medium","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Used to identify a medium such as email or cost-per-click (cpc)."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":200,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":311,"name":"source","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Used to identify a search engine, newsletter, or other source."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":196,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":314,"name":"term","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Used with paid search to supply the keywords for ads."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":208,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[316,313,315,317,312,311,314]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":192,"character":49}]},{"id":318,"name":"EarnVirtualCurrencyEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":320,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":229,"character":9}],"type":{"type":"intrinsic","name":"number"}},{"id":319,"name":"virtual_currency_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Name of virtual currency type. E.g. `gems`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":224,"character":25}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[320,319]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":220,"character":53}]},{"id":321,"name":"EcommercePurchaseEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":327,"name":"coupon","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Coupon code for a purchasable item."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":258,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":322,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":236,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":333,"name":"destination","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel destination. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":282,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":335,"name":"end_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":290,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":328,"name":"location","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Google [Place ID](https://developers.google.com/places/place-id) that corresponds to the associated event. Alternatively, you can supply your own custom Location ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":262,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":329,"name":"number_of_nights","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of nights staying at hotel."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":266,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":331,"name":"number_of_passengers","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of passengers traveling."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":274,"character":24}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":330,"name":"number_of_rooms","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of rooms for travel events."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":270,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":332,"name":"origin","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel origin. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":278,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":326,"name":"shipping","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Shipping cost."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":254,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":334,"name":"start_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":286,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":325,"name":"tax","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Tax amount."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":250,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":324,"name":"transaction_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A single ID for a ecommerce group transaction."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":246,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":336,"name":"travel_class","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Travel class. E.g. `business`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":294,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":323,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":242,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[327,322,333,335,328,329,331,330,332,326,334,325,324,336,323]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":232,"character":51}]},{"id":337,"name":"GenerateLeadEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":338,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":301,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":339,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":307,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[338,339]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":297,"character":46}]},{"id":340,"name":"JoinGroupEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":341,"name":"group_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Group/clan/guild id."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":314,"character":12}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[341]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":310,"character":43}]},{"id":342,"name":"LevelEndEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":343,"name":"level","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Level in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":321,"character":9}],"type":{"type":"intrinsic","name":"number"}},{"id":344,"name":"success","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The result of an operation."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":325,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[343,344]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":317,"character":42}]},{"id":345,"name":"LevelStartEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":346,"name":"level","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Level in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":332,"character":9}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[346]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":328,"character":44}]},{"id":347,"name":"LevelUpEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":349,"name":"character","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Character used in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":343,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":348,"name":"level","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Level in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":339,"character":9}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[349,348]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":335,"character":41}]},{"id":350,"name":"LoginEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":351,"name":"method","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The login method. E.g. `facebook.com`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":350,"character":10}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[351]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":346,"character":39}]},{"id":352,"name":"PostScoreEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":355,"name":"character","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Character used in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":365,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":354,"name":"level","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Level in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":361,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":353,"name":"score","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Score in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":357,"character":9}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[355,354,353]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":353,"character":43}]},{"id":356,"name":"PresentOfferEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":359,"name":"character","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Character used in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":380,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":358,"name":"level","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Level in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":376,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":357,"name":"score","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Score in game."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":372,"character":9}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[359,358,357]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":368,"character":46}]},{"id":360,"name":"PurchaseRefundEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":361,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":387,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":363,"name":"transaction_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A single ID for a ecommerce group transaction."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":397,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":362,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":393,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[361,363,362]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":383,"character":48}]},{"id":364,"name":"RemoveFromCartEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":371,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":430,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":376,"name":"destination","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel destination. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":450,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":374,"name":"end_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":442,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":367,"name":"item_category","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item category."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":412,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":365,"name":"item_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":404,"character":11}],"type":{"type":"intrinsic","name":"string"}},{"id":372,"name":"item_location_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Google [Place ID](https://developers.google.com/places/place-id) that corresponds to the associated item (String). Alternatively, you can supply your own custom Location ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":434,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":366,"name":"item_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item name."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":408,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":375,"name":"origin","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel origin. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":446,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":370,"name":"price","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase price."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":426,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":368,"name":"quantity","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase quantity."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":416,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":373,"name":"start_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":438,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":369,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":422,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[371,376,374,367,365,372,366,375,370,368,373,369]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":400,"character":48}]},{"id":377,"name":"SearchEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":383,"name":"destination","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel destination. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":474,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":385,"name":"end_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":482,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":379,"name":"number_of_nights","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of nights staying at hotel."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":458,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":381,"name":"number_of_passengers","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of passengers traveling."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":466,"character":24}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":380,"name":"number_of_rooms","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of rooms for travel events."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":462,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":382,"name":"origin","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel origin. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":470,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":378,"name":"search_term","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":454,"character":15}],"type":{"type":"intrinsic","name":"string"}},{"id":384,"name":"start_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":478,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":386,"name":"travel_class","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Travel class. E.g. `business`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":486,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[383,385,379,381,380,382,378,384,386]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":453,"character":40}]},{"id":387,"name":"SelectContentEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":388,"name":"content_type","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":490,"character":16}],"type":{"type":"intrinsic","name":"string"}},{"id":389,"name":"item_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":494,"character":11}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[388,389]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":489,"character":47}]},{"id":390,"name":"SetCheckoutOptionEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":392,"name":"checkout_option","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Some option on a step in an ecommerce flow."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":505,"character":19}],"type":{"type":"intrinsic","name":"string"}},{"id":391,"name":"checkout_step","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The checkout step (1..N)."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":501,"character":17}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[392,391]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":497,"character":51}]},{"id":393,"name":"ShareEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":394,"name":"content_type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Type of content selected."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":512,"character":16}],"type":{"type":"intrinsic","name":"string"}},{"id":395,"name":"item_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":516,"character":11}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[394,395]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":508,"character":39}]},{"id":396,"name":"SignUpEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":397,"name":"method","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A particular approach used in an operation; for example, \"facebook\" or \"email\" in the context of a sign_up or login event."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":523,"character":10}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[397]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":519,"character":40}]},{"id":398,"name":"SpendVirtualCurrencyEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":399,"name":"item_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item name."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":530,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":401,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":540,"character":9}],"type":{"type":"intrinsic","name":"number"}},{"id":400,"name":"virtual_currency_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Name of virtual currency type. E.g. `gems`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":534,"character":25}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[399,401,400]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":526,"character":54}]},{"id":427,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":641,"character":26}]},{"id":402,"name":"UnlockAchievementEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":403,"name":"achievement_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Game achievement ID (String)."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":547,"character":18}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[403]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":543,"character":51}]},{"id":404,"name":"ViewItemEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":411,"name":"currency","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase currency in 3 letter [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. E.g. `USD`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":578,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":418,"name":"destination","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel destination. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":608,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":420,"name":"end_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":616,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":413,"name":"flight_number","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight number for travel events."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":588,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":407,"name":"item_category","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item category."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":562,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":405,"name":"item_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":554,"character":11}],"type":{"type":"intrinsic","name":"string"}},{"id":408,"name":"item_location_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Google [Place ID](https://developers.google.com/places/place-id) that corresponds to the associated item (String). Alternatively, you can supply your own custom Location ID."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":566,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":406,"name":"item_name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item name."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":558,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":415,"name":"number_of_nights","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of nights staying at hotel."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":596,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":414,"name":"number_of_passengers","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of passengers traveling."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":592,"character":24}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":416,"name":"number_of_rooms","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Number of rooms for travel events."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":600,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":417,"name":"origin","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Flight or Travel origin. E.g. `Mountain View, CA`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":604,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":409,"name":"price","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase price."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":570,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":410,"name":"quantity","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Purchase quantity."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":574,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":421,"name":"search_term","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The search string/keywords used."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":620,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":419,"name":"start_date","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":612,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":422,"name":"travel_class","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Travel class. E.g. `business`."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":624,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":412,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A context-specific numeric value which is accumulated automatically for each event type. Values\ncan include revenue, distance, time and points. When a value is set, the accompanying `currency`\nparameter should also be defined."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":584,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[411,418,420,413,407,405,408,406,415,414,416,417,409,410,421,419,422,412]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":550,"character":42}]},{"id":423,"name":"ViewItemListEventParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":424,"name":"item_category","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An item category."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":631,"character":17}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[424]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":627,"character":46}]},{"id":425,"name":"ViewSearchResults","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":426,"name":"search_term","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The search string/keywords used."},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":638,"character":15}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[426]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":634,"character":36}]}],"groups":[{"title":"Classes","kind":128,"children":[428]},{"title":"Interfaces","kind":256,"children":[276,289,298,310,318,321,337,340,342,345,347,350,352,356,360,364,377,387,390,393,396,398,427,402,404,423,425]}],"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":50,"character":39}]},{"id":556,"name":"FirebaseAuthTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Authentication package for React Native.","text":"#### Example: Access the firebase export from the `auth` package:\n\n```js\nimport { firebase } from '@react-native-firebase/auth';\n\n// firebase.auth().X\n```\n\n#### Example: Using the default export from the `auth` package:\n\n```js\nimport auth from '@react-native-firebase/auth';\n\n// auth().X\n```\n\n#### Example: Using the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/auth';\n\n// firebase.auth().X\n```\nTODO @salakar @ehesp missing auth providers (PhoneAuthProvider, Facebook etc)\n","tags":[{"tag":"firebase","text":"auth\n"}]},"children":[{"id":746,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Authentication service is available for the default app or a given app.","text":"#### Example 1\n\nGet the auth instance for the **default app**:\n\n```js\nconst authForDefaultApp = firebase.auth();\n```\n\n#### Example 2\n\nGet the auth instance for a **secondary app**:\n\n```js\nconst otherApp = firebase.app('otherApp');\nconst authForOtherApp = firebase.auth(otherApp);\n```\n\nTODO @salakar missing updateCurrentUser\n"},"children":[{"id":829,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":752,"name":"currentUser","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the currently signed-in user (or null if no user signed in). See the User interface documentation for detailed usage.","text":"#### Example\n\n```js\nconst user = firebase.auth().currentUser;\n```\n\n> It is recommended to use {@link auth#onAuthStateChanged} to track whether the user is currently signed in.\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1209,"character":15}],"type":{"type":"union","types":[{"type":"reference","name":"User","id":699},{"type":"intrinsic","name":"null"}]}},{"id":751,"name":"settings","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the current `AuthSettings`."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1196,"character":12}],"type":{"type":"reference","name":"AuthSettings","id":693}},{"id":747,"name":"languageCode","kind":262144,"kindString":"Accessor","flags":{"isExported":true},"comment":{"shortText":"Gets the current language code.\nSets the language code.","text":"#### Example\n\n```js\nconst language = firebase.auth().languageCode;\n```\n\n#### Example\n\n```js\n// Set language to French\nfirebase.auth().languageCode = 'fr';\n```\n"},"getSignature":[{"id":748,"name":"__get","kind":524288,"kindString":"Get signature","flags":{},"comment":{"shortText":"Gets the current language code.","text":"#### Example\n\n```js\nconst language = firebase.auth().languageCode;\n```\n"},"type":{"type":"intrinsic","name":"string"}}],"setSignature":[{"id":749,"name":"__set","kind":1048576,"kindString":"Set signature","flags":{},"comment":{"shortText":"Sets the language code.","text":"#### Example\n\n```js\n// Set language to French\nfirebase.auth().languageCode = 'fr';\n```\n"},"parameters":[{"id":750,"name":"code","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"An ISO language code.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1177,"character":20},{"fileName":"packages/auth/lib/index.d.ts","line":1191,"character":20}]},{"id":814,"name":"applyActionCode","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":815,"name":"applyActionCode","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Applies a verification code sent to the user by email or other out-of-band mechanism.","text":"#### Example\n\n```js\nawait firebase.auth().applyActionCode('ABCD');\n```\n","tags":[{"tag":"error","text":"auth/expired-action-code Thrown if the action code has expired."},{"tag":"error","text":"auth/invalid-action-code Thrown if the action code is invalid. This can happen if the code is malformed or has already been used."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given action code has been disabled."},{"tag":"error","text":"auth/user-not-found Thrown if there is no user corresponding to the action code. This may have happened if the user was deleted between when the action code was issued and when this method was called."}]},"parameters":[{"id":816,"name":"code","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A verification code sent to the user.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1542,"character":19}]},{"id":817,"name":"checkActionCode","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":818,"name":"checkActionCode","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Checks a verification code sent to the user by email or other out-of-band mechanism.","text":"#### Example\n\n```js\nconst actionCodeInfo = await firebase.auth().checkActionCode('ABCD');\nconsole.log('Action code operation: ', actionCodeInfo.operation);\n```\n","tags":[{"tag":"error","text":"auth/expired-action-code Thrown if the action code has expired."},{"tag":"error","text":"auth/invalid-action-code Thrown if the action code is invalid. This can happen if the code is malformed or has already been used."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given action code has been disabled."},{"tag":"error","text":"auth/user-not-found Thrown if there is no user corresponding to the action code. This may have happened if the user was deleted between when the action code was issued and when this method was called."}]},"parameters":[{"id":819,"name":"code","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A verification code sent to the user.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"ActionCodeInfo","id":640}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1560,"character":19}]},{"id":810,"name":"confirmPasswordReset","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":811,"name":"confirmPasswordReset","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Completes the password reset process with the confirmation code and new password, via\n{@link auth#sendPasswordResetEmail}.","text":"#### Example\n\n```js\nawait firebase.auth().confirmPasswordReset('ABCD', '1234567');\n```\n","tags":[{"tag":"error","text":"auth/expired-action-code Thrown if the password reset code has expired."},{"tag":"error","text":"auth/invalid-action-code Thrown if the password reset code is invalid. This can happen if the code is malformed or has already been used."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given password reset code has been disabled."},{"tag":"error","text":"auth/user-not-found Thrown if there is no user corresponding to the password reset code. This may have happened if the user was deleted between when the code was issued and when this method was called."},{"tag":"error","text":"auth/weak-password Thrown if the new password is not strong enough."}]},"parameters":[{"id":812,"name":"code","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The code from the password reset email."},"type":{"type":"intrinsic","name":"string"}},{"id":813,"name":"newPassword","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new password.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1525,"character":24}]},{"id":781,"name":"createUserWithEmailAndPassword","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":782,"name":"createUserWithEmailAndPassword","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new user with an email and password.","text":"This method also signs the user in once the account has been created.\n\n#### Example\n\n```js\nconst userCredential = await firebase.auth().createUserWithEmailAndPassword('joe.bloggs@example.com', '123456');\n```\n","tags":[{"tag":"error","text":"auth/email-already-in-use Thrown if there already exists an account with the given email address."},{"tag":"error","text":"auth/invalid-email Thrown if the email address is not valid."},{"tag":"error","text":"auth/operation-not-allowed Thrown if email/password accounts are not enabled. Enable email/password accounts in the Firebase Console, under the Auth tab."},{"tag":"error","text":"auth/weak-password Thrown if the password is not strong enough."}]},"parameters":[{"id":783,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users email address."},"type":{"type":"intrinsic","name":"string"}},{"id":784,"name":"password","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users password.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1372,"character":34}]},{"id":820,"name":"fetchSignInMethodsForEmail","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":821,"name":"fetchSignInMethodsForEmail","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a list of authentication methods that can be used to sign in a given user (identified by its main email address).","text":"#### Example\n\n```js\nconst methods = await firebase.auth().fetchSignInMethodsForEmail('joe.bloggs@example.com');\n\nmethods.forEach((method) => {\n  console.log(method);\n});\n```\n","tags":[{"tag":"error","text":"auth/invalid-email Thrown if the email address is not valid."}]},"parameters":[{"id":822,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users email address.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1578,"character":30}]},{"id":803,"name":"isSignInWithEmailLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":804,"name":"isSignInWithEmailLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns whether the user signed in with a given email link.","text":"#### Example\n\n```js\nconst signedInWithLink = firebase.auth().isSignInWithEmailLink(link);\n```\n"},"parameters":[{"id":805,"name":"emailLink","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The email link to check whether the user signed in with it.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1488,"character":25}]},{"id":753,"name":"onAuthStateChanged","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":754,"name":"onAuthStateChanged","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen for changes in the users auth state (logging in and out).\nThis method returns a unsubscribe function to stop listening to events.\nAlways ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use.","text":"#### Example\n\n```js\nconst unsubscribe = firebase.auth().onAuthStateChanged((user) => {\n  if (user) {\n    // Signed in\n  } else {\n    // Signed out\n  }\n});\n\n// Unsubscribe from further state changes\nunsubscribe();\n```\n"},"parameters":[{"id":755,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A listener function which triggers when auth state changed (for example signing out).\n"},"type":{"type":"reference","name":"AuthListenerCallback","id":830}}],"type":{"type":"reflection","declaration":{"id":756,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":757,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1233,"character":55}]}}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1233,"character":22}]},{"id":758,"name":"onIdTokenChanged","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":759,"name":"onIdTokenChanged","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen for changes in ID token.\nThis method returns a unsubscribe function to stop listening to events.\nAlways ensure you unsubscribe from the listener when no longer needed to prevent updates to components no longer in use.","text":"#### Example\n\n```js\nconst unsubscribe = firebase.auth().onIdTokenChanged((user) => {\n  if (user) {\n    // User is signed in or token was refreshed.\n  }\n});\n\n// Unsubscribe from further state changes\nunsubscribe();\n```\n"},"parameters":[{"id":760,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A listener function which triggers when the users ID token changes.\n"},"type":{"type":"reference","name":"AuthListenerCallback","id":830}}],"type":{"type":"reflection","declaration":{"id":761,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":762,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1255,"character":53}]}}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1255,"character":20}]},{"id":763,"name":"onUserChanged","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":764,"name":"onUserChanged","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Adds a listener to observe changes to the User object. This is a superset of everything from\n{@link auth#onAuthStateChanged}, {@link auth#onIdTokenChanged} and user changes. The goal of this\nmethod is to provide easier listening to all user changes, such as when credentials are\nlinked and unlinked, without manually having to call {@link auth.User#reload}.","text":"#### Example\n\n```js\nconst unsubscribe = firebase.auth().onUserChanged((user) => {\n  if (user) {\n    // User is signed in or token was refreshed.\n  }\n});\n\n// Unsubscribe from further state changes\nunsubscribe();\n```\n\n> This is an experimental feature and is only part of React Native Firebase.\n","tags":[{"tag":"react-native-firebase","text":""}]},"parameters":[{"id":765,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A listener function which triggers when the users data changes.\n"},"type":{"type":"reference","name":"AuthListenerCallback","id":830}}],"type":{"type":"reflection","declaration":{"id":766,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":767,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1281,"character":50}]}}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1281,"character":17}]},{"id":795,"name":"sendPasswordResetEmail","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":796,"name":"sendPasswordResetEmail","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends a password reset email to the given email address.\nUnlike the web SDK, the email will contain a password reset link rather than a code.","text":"#### Example\n\n```js\nawait firebase.auth().sendPasswordResetEmail('joe.bloggs@example.com');\n```\n","tags":[{"tag":"error","text":"auth/invalid-email Thrown if the email address is not valid."},{"tag":"error","text":"auth/missing-android-pkg-name An Android package name must be provided if the Android app is required to be installed."},{"tag":"error","text":"auth/missing-continue-uri A continue URL must be provided in the request."},{"tag":"error","text":"auth/missing-ios-bundle-id An iOS Bundle ID must be provided if an App Store ID is provided."},{"tag":"error","text":"auth/invalid-continue-uri The continue URL provided in the request is invalid."},{"tag":"error","text":"auth/unauthorized-continue-uri The domain of the continue URL is not whitelisted. Whitelist the domain in the Firebase console."},{"tag":"error","text":"auth/user-not-found Thrown if there is no user corresponding to the email address."}]},"parameters":[{"id":797,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users email address."},"type":{"type":"intrinsic","name":"string"}},{"id":798,"name":"actionCodeSettings","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Additional settings to be set before sending the reset email.\n"},"type":{"type":"reference","name":"ActionCodeSettings","id":645}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1454,"character":26}]},{"id":799,"name":"sendSignInLinkToEmail","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":800,"name":"sendSignInLinkToEmail","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends a sign in link to the user.","text":"#### Example\n\n```js\nawait firebase.auth().sendSignInLinkToEmail('joe.bloggs@example.com');\n```\n","tags":[{"tag":"error","text":"auth/argument-error Thrown if handleCodeInApp is false."},{"tag":"error","text":"auth/invalid-email Thrown if the email address is not valid."},{"tag":"error","text":"auth/missing-android-pkg-name An Android package name must be provided if the Android app is required to be installed."},{"tag":"error","text":"auth/missing-continue-uri A continue URL must be provided in the request."},{"tag":"error","text":"auth/missing-ios-bundle-id An iOS Bundle ID must be provided if an App Store ID is provided."},{"tag":"error","text":"auth/invalid-continue-uri The continue URL provided in the request is invalid."},{"tag":"error","text":"auth/unauthorized-continue-uri The domain of the continue URL is not whitelisted. Whitelist the domain in the Firebase console."}]},"parameters":[{"id":801,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users email address."},"type":{"type":"intrinsic","name":"string"}},{"id":802,"name":"actionCodeSettings","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The action code settings. The action code settings which provides Firebase with instructions on how to construct the email link. This includes the sign in completion URL or the deep link for mobile redirects, the mobile apps to use when the sign-in link is opened on an Android or iOS device. Mobile app redirects will only be applicable if the developer configures and accepts the Firebase Dynamic Links terms of condition. The Android package name and iOS bundle ID will be respected only if they are configured in the same Firebase Auth project used.\n"},"type":{"type":"reference","name":"ActionCodeSettings","id":645}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1475,"character":25}]},{"id":770,"name":"signInAnonymously","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":771,"name":"signInAnonymously","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sign in a user anonymously. If the user has already signed in, that user will be returned.","text":"#### Example\n\n```js\nconst userCredential = await firebase.auth().signInAnonymously();\n```\n","tags":[{"tag":"error","text":"auth/operation-not-allowed Thrown if anonymous accounts are not enabled. Enable anonymous accounts in the Firebase Console, under the Auth tab.\n"}]},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1308,"character":21}]},{"id":792,"name":"signInWithCredential","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":793,"name":"signInWithCredential","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Signs the user in with a generated credential.","text":"#### Example\n\n```js\n// Generate a Firebase credential\nconst credential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook');\n// Sign the user in with the credential\nconst userCredential = await firebase.auth().signInWithCredential(credential);\n```\n","tags":[{"tag":"error","text":"auth/account-exists-with-different-credential Thrown if there already exists an account with the email address asserted by the credential."},{"tag":"error","text":"auth/invalid-credential Thrown if the credential is malformed or has expired."},{"tag":"error","text":"auth/operation-not-allowed Thrown if the type of account corresponding to the credential is not enabled. Enable the account type in the Firebase Console, under the Auth tab."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given credential has been disabled."},{"tag":"error","text":"auth/user-not-found Thrown if signing in with a credential from firebase.auth.EmailAuthProvider.credential and there is no user corresponding to the given email."},{"tag":"error","text":"auth/wrong-password Thrown if signing in with a credential from firebase.auth.EmailAuthProvider.credential and the password is invalid for the given email, or if the account corresponding to the email does not have a password set."},{"tag":"error","text":"auth/invalid-verification-code Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification code of the credential is not valid."},{"tag":"error","text":"auth/invalid-verification-id Thrown if the credential is a firebase.auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid."}]},"parameters":[{"id":794,"name":"credential","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A generated `AuthCredential`, for example from social auth.\n"},"type":{"type":"reference","name":"AuthCredential","id":557}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1432,"character":24}]},{"id":789,"name":"signInWithCustomToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":790,"name":"signInWithCustomToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Signs a user in with a custom token.","text":"#### Example\n\n```js\n// Create a custom token via the Firebase Admin SDK.\nconst token = await firebase.auth().createCustomToken(uid, customClaims);\n...\n// Use the token on the device to sign in.\nconst userCredential = await firebase.auth().signInWithCustomToken(token);\n```\n","tags":[{"tag":"error","text":"auth/custom-token-mismatch Thrown if the custom token is for a different Firebase App."},{"tag":"error","text":"auth/invalid-custom-token Thrown if the custom token format is incorrect."}]},"parameters":[{"id":791,"name":"customToken","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A custom token generated from the Firebase Admin SDK.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1408,"character":25}]},{"id":785,"name":"signInWithEmailAndPassword","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":786,"name":"signInWithEmailAndPassword","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Signs a user in with an email and password.","text":"#### Example\n\n```js\nconst userCredential = await firebase.auth().signInWithEmailAndPassword('joe.bloggs@example.com', '123456');\n````","tags":[{"tag":"error","text":"auth/invalid-email Thrown if the email address is not valid."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given email has been disabled."},{"tag":"error","text":"auth/user-not-found Thrown if there is no user corresponding to the given email."},{"tag":"error","text":"auth/wrong-password Thrown if the password is invalid for the given email, or the account corresponding to the email does not have a password set."}]},"parameters":[{"id":787,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users email address."},"type":{"type":"intrinsic","name":"string"}},{"id":788,"name":"password","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users password.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1389,"character":30}]},{"id":806,"name":"signInWithEmailLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":807,"name":"signInWithEmailLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Signs the user in with an email link.","text":"#### Example\n\n```js\nconst userCredential = await firebase.auth().signInWithEmailLink('joe.bloggs@example.com', link);\n```\n","tags":[{"tag":"error","text":"auth/expired-action-code Thrown if OTP in email link expires."},{"tag":"error","text":"auth/invalid-email Thrown if the email address is not valid."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given email has been disabled."}]},"parameters":[{"id":808,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users email to sign in with."},"type":{"type":"intrinsic","name":"string"}},{"id":809,"name":"emailLink","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An email link.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1505,"character":23}]},{"id":772,"name":"signInWithPhoneNumber","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":773,"name":"signInWithPhoneNumber","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Signs in the user using their phone number.","text":"#### Example\n\n```js\n// Force a new message to be sent\nconst result = await firebase.auth().signInWithPhoneNumber('#4423456789', true);\n```\n","tags":[{"tag":"error","text":"auth/invalid-phone-number Thrown if the phone number has an invalid format."},{"tag":"error","text":"auth/missing-phone-number Thrown if the phone number is missing."},{"tag":"error","text":"auth/quota-exceeded Thrown if the SMS quota for the Firebase project has been exceeded."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given phone number has been disabled."},{"tag":"error","text":"auth/operation-not-allowed Thrown if you have not enabled the provider in the Firebase Console. Go to the Firebase Console for your project, in the Auth section and the Sign in Method tab and configure the provider."}]},"parameters":[{"id":774,"name":"phoneNumber","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The devices phone number."},"type":{"type":"intrinsic","name":"string"}},{"id":775,"name":"forceResend","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Forces a new message to be sent if it was already recently sent.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"ConfirmationResult","id":628}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1328,"character":25}]},{"id":768,"name":"signOut","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":769,"name":"signOut","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Signs the user out.","text":"Triggers the {@link auth#onAuthStateChanged} listener.\n\n#### Example\n\n```js\nawait firebase.auth().signOut();\n```\n\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1295,"character":11}]},{"id":826,"name":"useUserAccessGroup","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":827,"name":"useUserAccessGroup","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Switch userAccessGroup and current user to the given accessGroup and the user stored in it.\nSign in a user with any sign in method, and the same current user is available in all\napps in the access group.","text":"Set the `useAccessGroup` argument to `null` to stop sharing the auth state (default behaviour), the user state will no longer be\navailable to any other apps.\n","tags":[{"tag":"platform","text":"ios\n"}]},"parameters":[{"id":828,"name":"userAccessGroup","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A string of the keychain id i.e. \"TEAMID.com.example.group1\"\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1609,"character":22}]},{"id":823,"name":"verifyPasswordResetCode","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":824,"name":"verifyPasswordResetCode","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Checks a password reset code sent to the user by email or other out-of-band mechanism.\nTODO salakar: confirm return behavior (Returns the user's email address if valid.)","text":"#### Example\n\n```js\nawait firebase.auth().verifyPasswordResetCode('ABCD');\n```\n","tags":[{"tag":"error","text":"auth/expired-action-code Thrown if the password reset code has expired."},{"tag":"error","text":"auth/invalid-action-code Thrown if the password reset code is invalid. This can happen if the code is malformed or has already been used."},{"tag":"error","text":"auth/user-disabled Thrown if the user corresponding to the given password reset code has been disabled."},{"tag":"error","text":"auth/user-not-found Thrown if there is no user corresponding to the password reset code. This may have happened if the user was deleted between when the code was issued and when this method was called."}]},"parameters":[{"id":825,"name":"code","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A password reset code.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1596,"character":27}]},{"id":776,"name":"verifyPhoneNumber","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":777,"name":"verifyPhoneNumber","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a PhoneAuthListener to listen to phone verification events,\non the final completion event a PhoneAuthCredential can be generated for\nauthentication purposes.","text":"#### Example\n\n```js\nfirebase.auth().verifyPhoneNumber('+4423456789', )\n .on('state_changed', (phoneAuthSnapshot) => {\n   console.log('Snapshot state: ', phoneAuthSnapshot.state);\n });\n```\n"},"parameters":[{"id":778,"name":"phoneNumber","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The phone number identifier supplied by the user. Its format is normalized on the server, so it can be in any format here. (e.g. +16505550101)."},"type":{"type":"intrinsic","name":"string"}},{"id":779,"name":"autoVerifyTimeoutOrForceResend","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"If a number, sets in seconds how to to wait until auto verification times out. If boolean, sets the `forceResend` parameter."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"boolean"}]}},{"id":780,"name":"forceResend","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"If true, resend the verification message even if it was recently sent.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"type":{"type":"reference","name":"PhoneAuthListener","id":661}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1348,"character":21}]}],"groups":[{"title":"Properties","kind":1024,"children":[829,752,751]},{"title":"Accessors","kind":262144,"children":[747]},{"title":"Methods","kind":2048,"children":[814,817,810,781,820,803,753,758,763,795,799,770,792,789,785,806,772,768,826,823,776]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1167,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":640,"name":"ActionCodeInfo","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The interface returned from a {@link auth#checkActionCode} call.","text":"#### Example\n\n```js\nconst actionCodeInfo = await firebase.auth().checkActionCode('ABCD');\nconsole.log('Action code operation: ', actionCodeInfo.operation);\n```\n"},"children":[{"id":641,"name":"data","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The data associated with the action code."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":561,"character":8}],"type":{"type":"reference","name":"ActionCodeInfoData","id":637}},{"id":642,"name":"operation","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The operation from where the action originated."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":565,"character":13}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"PASSWORD_RESET"},{"type":"stringLiteral","value":"VERIFY_EMAIL"},{"type":"stringLiteral","value":"RECOVER_EMAIL"},{"type":"stringLiteral","value":"EMAIL_SIGNIN"},{"type":"stringLiteral","value":"ERROR"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[641,642]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":557,"character":33}]},{"id":637,"name":"ActionCodeInfoData","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Additional data returned from a {@link auth#checkActionCode} call.\nFor the PASSWORD_RESET, VERIFY_EMAIL, and RECOVER_EMAIL actions, this object contains an email field with the address the email was sent to.\nFor the RECOVER_EMAIL action, which allows a user to undo an email address change, this object also contains a fromEmail field with the user account's new email address. After the action completes, the user's email address will revert to the value in the email field from the value in fromEmail field.","text":"#### Example\n\n```js\nconst actionCodeInfo = await firebase.auth().checkActionCode('ABCD');\nData\nconsole.log('Action code email: ', actionCodeInfo.data.email);\nconsole.log('Action code from email: ', actionCodeInfo.data.fromEmail);\n```\n"},"children":[{"id":638,"name":"email","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"This signifies the email before the call was made."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":540,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":639,"name":"fromEmail","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"This signifies the current email associated with the account, which may have changed as a result of the {@link auth#checkActionCode} call performed."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":544,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[638,639]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":536,"character":37}]},{"id":645,"name":"ActionCodeSettings","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Options to be sent with requests such as {@link auth.User#sendEmailVerification}.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.sendEmailVerification({\n handleCodeInApp: true,\n url: 'app/email-verification',\n});\n```\n"},"children":[{"id":646,"name":"android","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Android specific settings."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":605,"character":11}],"type":{"type":"reference","name":"ActionCodeSettingsAndroid","id":633}},{"id":649,"name":"dynamicLinkDomain","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the dynamic link domain (or subdomain) to use for the current link if it is to be opened using Firebase Dynamic Links. As multiple dynamic link domains can be configured per project, this field provides the ability to explicitly choose one. If none is provided, the first domain is used by default."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":620,"character":21}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":647,"name":"handleCodeInApp","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Whether the email action link will be opened in a mobile app or a web link first. The default is false. When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":610,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":648,"name":"iOS","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"iOS specific settings."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":615,"character":7}],"type":{"type":"reference","name":"ActionCodeSettingsIos","id":643}},{"id":650,"name":"url","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"This URL represents the state/Continue URL in the form of a universal link. This URL can should be constructed as a universal link that would either directly open the app where the action code would be handled or continue to the app after the action code is handled by Firebase."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":625,"character":7}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[646,649,647,648,650]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":601,"character":37}]},{"id":633,"name":"ActionCodeSettingsAndroid","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Android specific options which can be attached to the {@link auth.ActionCodeSettings} object\nto be sent with requests such as {@link auth.User#sendEmailVerification}.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.sendEmailVerification({\n android: {\n   installApp: true,\n   packageName: 'com.awesome.app',\n },\n});\n```\n"},"children":[{"id":635,"name":"installApp","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If installApp is passed, it specifies whether to install the Android app if the device supports it and the app is not already installed. If this field is provided without a packageName, an error is thrown explaining that the packageName must be provided in conjunction with this field."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":515,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":636,"name":"minimumVersion","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If minimumVersion is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app. The Android app needs to be registered in the Console."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":519,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":634,"name":"packageName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Sets the Android package name. This will try to open the link in an android app if it is installed."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":511,"character":15}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[635,636,634]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":507,"character":44}]},{"id":643,"name":"ActionCodeSettingsIos","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"iOS specific options which can be attached to the {@link auth.ActionCodeSettings} object\nto be sent with requests such as {@link auth.User#sendEmailVerification}.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.sendEmailVerification({\n iOS: {\n   bundleId: '123456',\n },\n});\n```\n"},"children":[{"id":644,"name":"bundleId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed. The iOS app needs to be registered in the Console."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":586,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[644]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":582,"character":40}]},{"id":597,"name":"AdditionalUserInfo","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A structure containing additional user information from a federated identity provider via {@link auth.UserCredential}.","text":"#### Example\n\n```js\nconst userCredential = await firebase.auth().signInAnonymously();\nconsole.log('Additional user info: ', userCredential.additionalUserInfo);\n```\n","tags":[{"tag":"error","text":"auth/operation-not-allowed Thrown if anonymous accounts are not enabled. Enable anonymous accounts in the Firebase Console, under the Auth tab.\n"}]},"children":[{"id":598,"name":"isNewUser","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns whether the user is new or existing."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":296,"character":13}],"type":{"type":"intrinsic","name":"boolean"}},{"id":599,"name":"profile","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns an Object containing IDP-specific user data if the provider is one of Facebook,\nGitHub, Google, Twitter, Microsoft, or Yahoo."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":301,"character":11}],"type":{"type":"reference","name":"Object"}},{"id":600,"name":"providerId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the provider ID for specifying which provider the information in `profile` is for."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":305,"character":14}],"type":{"type":"intrinsic","name":"string"}},{"id":601,"name":"username","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns the username if the provider is GitHub or Twitter."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":309,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[598,599,600,601]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":292,"character":37}]},{"id":557,"name":"AuthCredential","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Interface that represents the credentials returned by an auth provider. Implementations specify the details\nabout each auth provider's credential requirements.","text":"TODO Missing; signInMethod, toJSON, fromJSON\n\n#### Example\n\n```js\nconst provider = firebase.auth.EmailAuthProvider;\nconst authCredential = provider.credential('foo@bar.com', '123456');\n\nawait firebase.auth().signInWithCredential(authCredential);\n```\n"},"children":[{"id":558,"name":"providerId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The authentication provider ID for the credential. For example, 'facebook.com', or 'google.com'."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":74,"character":14}],"type":{"type":"intrinsic","name":"string"}},{"id":560,"name":"secret","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":76,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":559,"name":"token","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":75,"character":9}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[558,560,559]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":70,"character":33}]},{"id":561,"name":"AuthProvider","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Interface that represents an auth provider. Implemented by other providers."},"children":[{"id":562,"name":"PROVIDER_ID","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The provider ID of the provider."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":86,"character":15}],"type":{"type":"intrinsic","name":"string"}},{"id":563,"name":"credential","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Creates a new `AuthCredential`.","tags":[{"tag":"returns","text":"."},{"tag":"param","text":"A provider token.","param":"token"},{"tag":"param","text":"A provider secret.\n","param":"secret"}]},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":94,"character":14}],"type":{"type":"reflection","declaration":{"id":564,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":565,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":566,"name":"token","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":567,"name":"secret","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"AuthCredential","id":557}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":94,"character":15}]}}}],"groups":[{"title":"Properties","kind":1024,"children":[562,563]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":82,"character":31}]},{"id":693,"name":"AuthSettings","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Interface for module auth settings.","text":"#### Example\n\n```js\nconst settings = firebase.auth().settings;\nconsole.log(settings.appVerificationDisabledForTesting);\n```\n"},"children":[{"id":694,"name":"appVerificationDisabledForTesting","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"iOS only flag to disable app verification for the purpose of testing phone authentication. For this property to take effect, it needs to be set before rendering a reCAPTCHA app verifier. When this is disabled, a mock reCAPTCHA is rendered instead. This is useful for manual testing during development or for automated integration tests.","text":"> In order to use this feature, you will need to [whitelist your phone number](https://firebase.google.com/docs/auth/web/phone-auth#test-with-whitelisted-phone-numbers) via the Firebase Console.\n","tags":[{"tag":"ios","text":""},{"tag":"param","text":"Boolean value representing whether app verification should be disabled for testing.\n","param":"disabled"}]},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":822,"character":37}],"type":{"type":"intrinsic","name":"boolean"}},{"id":695,"name":"setAutoRetrievedSmsCodeForPhoneNumber","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":696,"name":"setAutoRetrievedSmsCodeForPhoneNumber","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Calling this method a second time will overwrite the previously passed parameters.\nOnly one number can be configured at a given time.","text":"> The phone number and SMS code here must have been configured in the Firebase Console (Authentication > Sign In Method > Phone).\n\n#### Example\n\n```js\nawait firebase.auth().settings.setAutoRetrievedSmsCodeForPhoneNumber('+4423456789', 'ABCDE');\n```\n","tags":[{"tag":"android","text":""}]},"parameters":[{"id":697,"name":"phoneNumber","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users phone number."},"type":{"type":"intrinsic","name":"string"}},{"id":698,"name":"smsCode","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The pre-set SMS code.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":840,"character":41}]}],"groups":[{"title":"Properties","kind":1024,"children":[694]},{"title":"Methods","kind":2048,"children":[695]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":813,"character":31}]},{"id":628,"name":"ConfirmationResult","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A result from a {@link auth#signInWithPhoneNumber} call.","text":"#### Example\n\n```js\n// Force a new message to be sent\nconst result = await firebase.auth().signInWithPhoneNumber('#4423456789');\nconst user = await result.confirm('12345');\n```\n"},"children":[{"id":629,"name":"verificationId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The phone number authentication operation's verification ID. This can be used along with\nthe verification code to initialize a phone auth credential."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":483,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":630,"name":"confirm","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":631,"name":"confirm","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Finishes the sign in flow. Validates a code that was sent to the users device."},"parameters":[{"id":632,"name":"verificationCode","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The code sent to the users device from Firebase.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"union","types":[{"type":"reference","name":"User","id":699},{"type":"intrinsic","name":"null"}]}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":489,"character":11}]}],"groups":[{"title":"Properties","kind":1024,"children":[629]},{"title":"Methods","kind":2048,"children":[630]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":478,"character":37}]},{"id":568,"name":"EmailAuthProvider","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Email and password auth provider implementation."},"children":[{"id":570,"name":"EMAIL_LINK_SIGN_IN_METHOD","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"This corresponds to the sign-in method identifier as returned in {@link auth#fetchSignInMethodsForEmail}.","text":"#### Example\n\n```js\nconst signInMethods = await firebase.auth().fetchSignInMethodsForEmail('...');\nif (signInMethods.indexOf(firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD) != -1) {\n  // User can sign in with email/link\n}\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":117,"character":29}],"type":{"type":"intrinsic","name":"string"}},{"id":571,"name":"EMAIL_PASSWORD_SIGN_IN_METHOD","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"This corresponds to the sign-in method identifier as returned in {@link auth#fetchSignInMethodsForEmail}.","text":"#### Example\n\n```js\nconst signInMethods = await firebase.auth().fetchSignInMethodsForEmail('...');\nif (signInMethods.indexOf(firebase.auth.EmailAuthProvider.EMAIL_PASSWORD_SIGN_IN_METHOD) != -1) {\n  // User can sign in with email/password\n}\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":130,"character":33}],"type":{"type":"intrinsic","name":"string"}},{"id":569,"name":"PROVIDER_ID","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The provider ID. Always returns `password`."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":104,"character":15}],"type":{"type":"intrinsic","name":"string"}},{"id":572,"name":"credential","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the auth provider credential.","text":"#### Example\n\n```js\nconst authCredential = firebase.auth.EmailAuthProvider.credential('joe.bloggs@example.com', '123456');\n```\n","tags":[{"tag":"returns","text":""},{"tag":"param","text":"Users email address.","param":"email"},{"tag":"param","text":"User account password.\n","param":"password"}]},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":144,"character":14}],"type":{"type":"reflection","declaration":{"id":573,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":574,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":575,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":576,"name":"password","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"AuthCredential","id":557}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":144,"character":15}]}}},{"id":577,"name":"credentialWithLink","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Initialize an `EmailAuthProvider` credential using an email and an email link after a sign in with email link operation.","text":"#### Example\n\n```js\nconst authCredential = firebase.auth.EmailAuthProvider.credentialWithLink('joe.bloggs@example.com', 'https://myexample.com/invite');\n```\n","tags":[{"tag":"param","text":"Users email address.","param":"email"},{"tag":"param","text":"Sign-in email link.\n","param":"emailLink"}]},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":157,"character":22}],"type":{"type":"reflection","declaration":{"id":578,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":579,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":580,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":581,"name":"emailLink","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"AuthCredential","id":557}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":157,"character":23}]}}}],"groups":[{"title":"Properties","kind":1024,"children":[570,571,569,572,577]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":100,"character":36}]},{"id":615,"name":"IdTokenResult","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Interface representing ID token result obtained from {@link auth.User#getIdTokenResult}.\nIt contains the ID token JWT string and other helper properties for getting different data\nassociated with the token as well as all the decoded payload claims.","text":"TODO @salakar validate timestamp types\n\n#### Example\n\n```js\nconst idTokenResult = await firebase.auth().currentUser.getIdTokenResult();\nconsole.log('User JWT: ', idTokenResult.token);\n```\n"},"children":[{"id":617,"name":"authTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The authentication time formatted as a UTC string. This is the time the user authenticated\n(signed in) and not the time the token was refreshed."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":419,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":621,"name":"claims","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The entire payload claims of the ID token including the standard reserved claims as well as\nthe custom claims."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":437,"character":10}],"type":{"type":"reflection","declaration":{"id":622,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":623,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":624,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":437,"character":11}]}}},{"id":619,"name":"expirationTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The ID token expiration time formatted as a UTC string."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":427,"character":18}],"type":{"type":"intrinsic","name":"string"}},{"id":618,"name":"issuedAtTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The ID token issued at time formatted as a UTC string."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":423,"character":16}],"type":{"type":"intrinsic","name":"string"}},{"id":620,"name":"signInProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The sign-in provider through which the ID token was obtained (anonymous, custom,\nphone, password, etc). Note, this does not map to provider IDs."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":432,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"string"}]}},{"id":616,"name":"token","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Firebase Auth ID token JWT string."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":414,"character":9}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[617,621,619,618,620,616]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":410,"character":32}]},{"id":656,"name":"PhoneAuthError","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A custom error in the event verifying a phone number failed.","text":"#### Example\n\n```js\nfirebase.auth().verifyPhoneNumber('+4423456789')\n .on('state_changed', (phoneAuthSnapshot) => {\n   console.log('Snapshot state: ', phoneAuthSnapshot.state);\n }, (phoneAuthError) => {\n   console.error('Error: ', phoneAuthError.message);\n });\n```\n"},"children":[{"id":657,"name":"code","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The code the verification failed with."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":701,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":659,"name":"message","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"JavaScript error message."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":709,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":660,"name":"stack","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"JavaScript error stack trace."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":713,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":658,"name":"verificationId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The verification ID which failed."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":705,"character":18}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[657,659,660,658]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":697,"character":33}]},{"id":661,"name":"PhoneAuthListener","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The listener function returned from a {@link auth#verifyPhoneNumber} call."},"children":[{"id":687,"name":"catch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":688,"name":"catch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"A promise handler called once the `on` listener flow has rejected.","text":"#### Example\n\n```js\nfirebase.auth().verifyPhoneNumber('+4423456789')\n .on('state_changed', (phoneAuthSnapshot) => {\n   return Promise.reject(\n     new Error('Code not sent!')\n   );\n })\n .catch((error) => {\n   console.error(error.message);\n });\n```\n\n> Used when no `onRejected` handler is passed to {@link auth.PhoneAuthListener#then}.\n"},"parameters":[{"id":689,"name":"onRejected","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Rejected promise handler.\n"},"type":{"type":"reflection","declaration":{"id":690,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":691,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":692,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"NativeFirebaseError","id":2}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":800,"character":21}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"any"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":800,"character":9}]},{"id":662,"name":"on","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":663,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"The phone auth state listener. See {@link auth.PhoneAuthState} for different event state types.","text":"#### Example\n\n```js\nfirebase.auth().verifyPhoneNumber('+4423456789')\n .on('state_changed', (phoneAuthSnapshot) => {\n   console.log('State: ', phoneAuthSnapshot.state);\n }, (error) => {\n   console.error(error);\n }, (phoneAuthSnapshot) => {\n   console.log('Success');\n });\n```\n"},"parameters":[{"id":664,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The event to subscribe to. Currently only `state_changed` is available."},"type":{"type":"intrinsic","name":"string"}},{"id":665,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The required observer function. Returns a new phone auth snapshot on each event."},"type":{"type":"reflection","declaration":{"id":666,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":667,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":668,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"PhoneAuthSnapshot","id":651}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":743,"character":15}]}}},{"id":669,"name":"errorCb","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional error handler function. This is not required if the `error` snapshot state is being handled in the `observer`."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":670,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":671,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":672,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"PhoneAuthError","id":656}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":673,"name":"successCb","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional success handler function. This is not required if the `sent` or `verified` snapshot state is being handled in the `observer`.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":674,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":675,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":676,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"PhoneAuthSnapshot","id":651}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reference","name":"PhoneAuthListener","id":661}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":741,"character":6}]},{"id":677,"name":"then","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":678,"name":"then","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"A promise handler called once the `on` listener flow has succeeded or rejected.","text":"#### Example\n\n```js\nfirebase.auth().verifyPhoneNumber('+4423456789')\n .on('state_changed', (phoneAuthSnapshot) => {\n   if (phoneAuthSnapshot.state === firebase.auth.PhoneAuthState.CODE_SENT) {\n     return Promise.resolve();\n   } else {\n     return Promise.reject(\n       new Error('Code not sent!')\n     );\n   }\n })\n .then((phoneAuthSnapshot) => {\n   console.log(phoneAuthSnapshot.state);\n }, (error) => {\n   console.error(error.message);\n });\n```\n"},"parameters":[{"id":679,"name":"onFulfilled","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Resolved promise handler."},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":680,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":681,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":682,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"PhoneAuthSnapshot","id":651}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":775,"character":19}]}},{"type":"intrinsic","name":"null"}]}},{"id":683,"name":"onRejected","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Rejected promise handler.\n"},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":684,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":685,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":686,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"NativeFirebaseError","id":2}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":776,"character":18}]}},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"any"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":774,"character":8}]}],"groups":[{"title":"Methods","kind":2048,"children":[687,662,677]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":719,"character":36}]},{"id":651,"name":"PhoneAuthSnapshot","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A snapshot interface of the current phone auth state.","text":"#### Example\n\n```js\nfirebase.auth().verifyPhoneNumber('+4423456789')\n .on('state_changed', (phoneAuthSnapshot) => {\n   console.log('Snapshot state: ', phoneAuthSnapshot.state);\n });\n```\n"},"children":[{"id":654,"name":"code","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The verification code. Will only be available if auto verification has taken place."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":676,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":655,"name":"error","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A native JavaScript error if an error occurs."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":680,"character":9}],"type":{"type":"union","types":[{"type":"reference","name":"NativeFirebaseError","id":2},{"type":"intrinsic","name":"null"}]}},{"id":652,"name":"state","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current phone auth verification state.","text":"- `sent`: On iOS, this is the final event received. Once sent, show a visible input box asking the user to enter the verification code.\n- `timeout`: Auto verification has timed out. Show a visible input box asking the user to enter the verification code.\n- `verified`: The verification code has automatically been verified by the Android device. The snapshot contains the verification ID & code to create a credential.\n- `error`: An error occurred. Handle or allow the promise to reject.\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":668,"character":9}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"sent"},{"type":"stringLiteral","value":"timeout"},{"type":"stringLiteral","value":"verified"},{"type":"stringLiteral","value":"error"}]}},{"id":653,"name":"verificationId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The verification ID to build a `PhoneAuthProvider` credential."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":672,"character":18}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[654,655,652,653]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":659,"character":36}]},{"id":582,"name":"PhoneAuthState","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{},"children":[{"id":585,"name":"AUTO_VERIFIED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Phone number auto-verification succeeded."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":175,"character":17}],"type":{"type":"stringLiteral","value":"verified"}},{"id":584,"name":"AUTO_VERIFY_TIMEOUT","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"SMS message with verification code sent to phone number."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":171,"character":23}],"type":{"type":"stringLiteral","value":"timeout"}},{"id":583,"name":"CODE_SENT","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The timeout specified in {@link auth#verifyPhoneNumber} has expired."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":167,"character":13}],"type":{"type":"stringLiteral","value":"sent"}},{"id":586,"name":"ERROR","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Phone number verification failed with an error."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":179,"character":9}],"type":{"type":"stringLiteral","value":"error"}}],"groups":[{"title":"Properties","kind":1024,"children":[585,584,583,586]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":163,"character":33}]},{"id":587,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"firebase.auth.X"},"children":[{"id":591,"name":"AppleAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Apple auth provider implementation. Currently this is iOS only.","text":"For Apple Authentication please see our [`@invertase/react-native-apple-authentication`](https://github.com/invertase/react-native-apple-authentication) library which integrates well with Firebase and provides Firebase + Apple Auth examples.\n\n#### Example\n\n```js\nfirebase.auth.AppleAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":227,"character":21}],"type":{"type":"reference","name":"AuthProvider","id":561}},{"id":588,"name":"EmailAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Email and password auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.EmailAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":195,"character":21}],"type":{"type":"reference","name":"EmailAuthProvider","id":568}},{"id":594,"name":"FacebookAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Facebook auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.FacebookAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":257,"character":24}],"type":{"type":"reference","name":"AuthProvider","id":561}},{"id":592,"name":"GithubAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Github auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.GithubAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":237,"character":22}],"type":{"type":"reference","name":"AuthProvider","id":561}},{"id":590,"name":"GoogleAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Google auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.GoogleAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":215,"character":22}],"type":{"type":"reference","name":"AuthProvider","id":561}},{"id":595,"name":"OAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Custom OAuth auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.OAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":267,"character":17}],"type":{"type":"reference","name":"AuthProvider","id":561}},{"id":589,"name":"PhoneAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Phone auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.PhoneAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":205,"character":21}],"type":{"type":"reference","name":"AuthProvider","id":561}},{"id":596,"name":"PhoneAuthState","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A PhoneAuthState interface.","text":"#### Example\n\n```js\nfirebase.auth.PhoneAuthState;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":277,"character":18}],"type":{"type":"reference","name":"PhoneAuthState","id":582}},{"id":593,"name":"TwitterAuthProvider","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Twitter auth provider implementation.","text":"#### Example\n\n```js\nfirebase.auth.TwitterAuthProvider;\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":247,"character":23}],"type":{"type":"reference","name":"AuthProvider","id":561}}],"groups":[{"title":"Properties","kind":1024,"children":[591,588,594,592,590,595,589,596,593]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":185,"character":26}]},{"id":625,"name":"UpdateProfile","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Request used to update user profile information.","text":"#### Example\n\n```js\nconst update = {\n  displayName: 'Alias',\n  photoURL: 'https://my-cdn.com/assets/user/123.png',\n};\n\nawait firebase.auth().currentUser.updateProfile(update);\n```\n"},"children":[{"id":626,"name":"displayName","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An optional display name for the user."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":460,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":627,"name":"photoURL","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An optional photo URL for the user."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":464,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[626,627]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":456,"character":32}]},{"id":699,"name":"User","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a user's profile information in your Firebase project's user database. It also\ncontains helper methods to change or retrieve profile information, as well as to manage that user's authentication state.","text":"#### Example 1\n\nSubscribing to the users authentication state.\n\n```js\nfirebase.auth().onAuthStateChanged((user) => {\n  if (user) {\n    console.log('User email: ', user.email');\n  }\n});\n```\n\n#### Example 2\n\n```js\nconst user = firebase.auth().currentUser;\n\nif (user) {\n console.log('User email: ', user.email');\n}\n```\n"},"children":[{"id":700,"name":"displayName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The user's display name (if available)."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":873,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":701,"name":"email","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"- The user's email address (if available)."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":877,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":702,"name":"emailVerified","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"- True if the user's email address has been verified."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":881,"character":17}],"type":{"type":"intrinsic","name":"boolean"}},{"id":703,"name":"isAnonymous","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns true if the user is anonymous; that is, the user account was created with\n{@link auth#signInAnonymously} and has not been linked to another account\nwith {@link auth#linkWithCredential}."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":887,"character":15}],"type":{"type":"intrinsic","name":"boolean"}},{"id":704,"name":"metadata","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the {@link auth.UserMetadata} associated with this user."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":892,"character":12}],"type":{"type":"reference","name":"UserMetadata","id":605}},{"id":705,"name":"phoneNumber","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the phone number of the user, as stored in the Firebase project's user database,\nor null if none exists. This can be updated at any time by calling {@link auth.User#updatePhoneNumber}."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":898,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":706,"name":"photoURL","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The URL of the user's profile picture (if available)."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":903,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":707,"name":"providerData","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Additional provider-specific information about the user."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":908,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"UserInfo","id":608}}},{"id":708,"name":"providerId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":" The authentication provider ID for the current user.\n For example, 'facebook.com', or 'google.com'."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":914,"character":14}],"type":{"type":"intrinsic","name":"string"}},{"id":709,"name":"uid","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":" - The user's unique ID."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":919,"character":7}],"type":{"type":"intrinsic","name":"string"}},{"id":710,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":711,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Delete the current user.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.delete();\n```\n","tags":[{"tag":"error","text":"auth/requires-recent-login Thrown if the user's last sign-in time does not meet the security threshold. Use `auth.User#reauthenticateWithCredential` to resolve. This does not apply if the user is anonymous.\n"}]},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":932,"character":10}]},{"id":712,"name":"getIdToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":713,"name":"getIdToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the users authentication token.","text":"#### Example\n\n```js\n// Force a token refresh\nconst idToken = await firebase.auth().currentUser.getIdToken(true);\n```\n"},"parameters":[{"id":714,"name":"forceRefresh","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A boolean value which forces Firebase to refresh the token.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":946,"character":14}]},{"id":715,"name":"getIdTokenResult","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":716,"name":"getIdTokenResult","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a firebase.auth.IdTokenResult object which contains the ID token JWT string and\nother helper properties for getting different data associated with the token as well as\nall the decoded payload claims.","text":"#### Example\n\n```js\n// Force a token refresh\nconst idTokenResult = await firebase.auth().currentUser.getIdTokenResult(true);\n```\n"},"parameters":[{"id":717,"name":"forceRefresh","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"boolean Force refresh regardless of token expiration.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"IdTokenResult","id":615}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":962,"character":20}]},{"id":718,"name":"linkWithCredential","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":719,"name":"linkWithCredential","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Link the user with a 3rd party credential provider.","text":"#### Example\n\n```js\nconst facebookCredential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook');\nconst userCredential = await firebase.auth().currentUser.linkWithCredential(facebookCredential);\n```\n","tags":[{"tag":"error","text":"auth/provider-already-linked Thrown if the provider has already been linked to the user. This error is thrown even if this is not the same provider's account that is currently linked to the user."},{"tag":"error","text":"auth/invalid-credential Thrown if the provider's credential is not valid. This can happen if it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method."},{"tag":"error","text":"auth/credential-already-in-use Thrown if the account corresponding to the credential already exists among your users, or is already linked to a Firebase User."},{"tag":"error","text":"auth/email-already-in-use Thrown if the email corresponding to the credential already exists among your users."},{"tag":"error","text":"auth/operation-not-allowed Thrown if you have not enabled the provider in the Firebase Console. Go to the Firebase Console for your project, in the Auth section and the Sign in Method tab and configure the provider."},{"tag":"error","text":"auth/invalid-email Thrown if the email used in a auth.EmailAuthProvider.credential is invalid."},{"tag":"error","text":"auth/wrong-password Thrown if the password used in a auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password."},{"tag":"error","text":"auth/invalid-verification-code Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification code of the credential is not valid."},{"tag":"error","text":"auth/invalid-verification-id Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid."}]},"parameters":[{"id":720,"name":"credential","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A created {@link auth.AuthCredential}.\n"},"type":{"type":"reference","name":"AuthCredential","id":557}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":985,"character":22}]},{"id":721,"name":"reauthenticateWithCredential","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":722,"name":"reauthenticateWithCredential","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Re-authenticate a user with a third-party authentication provider.","text":"#### Example\n\n```js\nconst facebookCredential = firebase.auth.FacebookAuthProvider.credential('access token from Facebook');\nconst userCredential = await firebase.auth().currentUser.reauthenticateWithCredential(facebookCredential);\n```\n","tags":[{"tag":"error","text":"auth/user-mismatch Thrown if the credential given does not correspond to the user."},{"tag":"error","text":"auth/user-not-found Thrown if the credential given does not correspond to any existing user."},{"tag":"error","text":"auth/invalid-credential Thrown if the provider's credential is not valid. This can happen if it has already expired when calling link, or if it used invalid token(s). See the Firebase documentation for your provider, and make sure you pass in the correct parameters to the credential method."},{"tag":"error","text":"auth/invalid-email Thrown if the email used in a auth.EmailAuthProvider.credential is invalid."},{"tag":"error","text":"auth/wrong-password Thrown if the password used in a auth.EmailAuthProvider.credential is not correct or when the user associated with the email does not have a password."},{"tag":"error","text":"auth/invalid-verification-code Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification code of the credential is not valid."},{"tag":"error","text":"auth/invalid-verification-id Thrown if the credential is a auth.PhoneAuthProvider.credential and the verification ID of the credential is not valid."}]},"parameters":[{"id":723,"name":"credential","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A created {@link auth.AuthCredential}.\n"},"type":{"type":"reference","name":"AuthCredential","id":557}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"UserCredential","id":602}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1006,"character":32}]},{"id":724,"name":"reload","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":725,"name":"reload","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Refreshes the current user.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.reload();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1017,"character":10}]},{"id":726,"name":"sendEmailVerification","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":727,"name":"sendEmailVerification","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends a verification email to a user.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.sendEmailVerification({\n  handleCodeInApp: true,\n});\n```\n\n> This will Promise reject if the user is anonymous.\n","tags":[{"tag":"error","text":"auth/missing-android-pkg-name An Android package name must be provided if the Android app is required to be installed."},{"tag":"error","text":"auth/missing-continue-uri A continue URL must be provided in the request."},{"tag":"error","text":"auth/missing-ios-bundle-id An iOS bundle ID must be provided if an App Store ID is provided."},{"tag":"error","text":"auth/invalid-continue-uri The continue URL provided in the request is invalid."},{"tag":"error","text":"auth/unauthorized-continue-uri The domain of the continue URL is not whitelisted. Whitelist the domain in the Firebase console."}]},"parameters":[{"id":728,"name":"actionCodeSettings","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Any optional additional settings to be set before sending the verification email.\n"},"type":{"type":"reference","name":"ActionCodeSettings","id":645}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1039,"character":25}]},{"id":729,"name":"toJSON","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":730,"name":"toJSON","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a JSON-serializable representation of this object.","text":"#### Example\n\n```js\nconst user = firebase.auth().currentUser.toJSON();\n```\n"},"type":{"type":"intrinsic","name":"object"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1050,"character":10}]},{"id":731,"name":"unlink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":732,"name":"unlink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unlinks a provider from a user account.","text":"#### Example\n\n```js\nconst user = await firebase.auth().currentUser.unlink('facebook.com');\n```\n","tags":[{"tag":"error","text":"auth/no-such-provider Thrown if the user does not have this provider linked or when the provider ID given does not exist."}]},"parameters":[{"id":733,"name":"providerId","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"User","id":699}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1064,"character":10}]},{"id":734,"name":"updateEmail","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":735,"name":"updateEmail","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates the user's email address.","text":"See Firebase docs for more information on security & email validation.\n\n#### Example\n\n```js\nawait firebase.auth().currentUser.updateEmail('joe.bloggs@new-email.com');\n```\n\n> This will Promise reject if the user is anonymous.\n","tags":[{"tag":"error","text":"auth/invalid-email Thrown if the email used is invalid."},{"tag":"error","text":"auth/email-already-in-use Thrown if the email is already used by another user."},{"tag":"error","text":"auth/requires-recent-login Thrown if the user's last sign-in time does not meet the security threshold."}]},"parameters":[{"id":736,"name":"email","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users new email address.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1084,"character":15}]},{"id":737,"name":"updatePassword","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":738,"name":"updatePassword","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates the users password.","text":"Important: this is a security sensitive operation that requires the user to have recently signed in.\nIf this requirement isn't met, ask the user to authenticate again and then call firebase.User#reauthenticate.\n\n#### Example\n\n```js\nawait firebase.auth().currentUser.updatePassword('654321');\n```\n\n> This will Promise reject is the user is anonymous.\n","tags":[{"tag":"error","text":"auth/weak-password Thrown if the password is not strong enough."},{"tag":"error","text":"auth/requires-recent-login Thrown if the user's last sign-in time does not meet the security threshold."}]},"parameters":[{"id":739,"name":"password","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The users new password.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1104,"character":18}]},{"id":740,"name":"updatePhoneNumber","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":741,"name":"updatePhoneNumber","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates the user's phone number.","text":"See Firebase docs for more information on security & email validation.\n\n#### Example\n\n```js\nconst snapshot = await firebase.auth().verifyPhoneNumber('+4423456789')\n .on(...); // See PhoneAuthListener - wait for successful verification\n\nconst credential = firebase.auth.PhoneAuthProvider.credential(snapshot.verificationId, snapshot.code);\n\n// Update user with new verified phone number\nawait firebase.auth().currentUser.updatePhoneNumber(credential);\n```\n\n> This will Promise reject is the user is anonymous.\n","tags":[{"tag":"error","text":"auth/invalid-verification-code Thrown if the verification code of the credential is not valid."},{"tag":"error","text":"auth/invalid-verification-id Thrown if the verification ID of the credential is not valid."}]},"parameters":[{"id":742,"name":"credential","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A created `PhoneAuthCredential`.\n"},"type":{"type":"reference","name":"AuthCredential","id":557}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1129,"character":21}]},{"id":743,"name":"updateProfile","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":744,"name":"updateProfile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates a user's profile data.","text":"#### Example\n\n```js\nawait firebase.auth().currentUser.updateProfile({\n  displayName: 'Alias',\n});\n```\n"},"parameters":[{"id":745,"name":"updates","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"UpdateProfile","id":625}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":1142,"character":17}]}],"groups":[{"title":"Properties","kind":1024,"children":[700,701,702,703,704,705,706,707,708,709]},{"title":"Methods","kind":2048,"children":[710,712,715,718,721,724,726,729,731,734,737,740,743]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":869,"character":23}]},{"id":602,"name":"UserCredential","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A structure containing a User, an AuthCredential, the operationType, and any additional user\ninformation that was returned from the identity provider. operationType could be 'signIn' for\na sign-in operation, 'link' for a linking operation and 'reauthenticate' for a reauthentication operation.","text":"TODO @salakar; missing credential, operationType\n"},"children":[{"id":603,"name":"additionalUserInfo","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Any additional user information assigned to the user."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":323,"character":22}],"type":{"type":"reference","name":"AdditionalUserInfo","id":597}},{"id":604,"name":"user","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the {@link auth.User} interface of this credential."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":327,"character":8}],"type":{"type":"reference","name":"User","id":699}}],"groups":[{"title":"Properties","kind":1024,"children":[603,604]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":319,"character":33}]},{"id":608,"name":"UserInfo","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a collection of standard profile information for a user. Can be used to expose\nprofile information returned by an identity provider, such as Google Sign-In or Facebook Login.","text":"TODO @salakar: isEmailVerified\n\n#### Example\n\n```js\nconst user = firebase.auth().currentUser;\n\nuser.providerData.forEach((userInfo) => {\n  console.log('User info for provider: ', userInfo);\n});\n```\n"},"children":[{"id":609,"name":"displayName","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns the user's display name, if available."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":373,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":610,"name":"email","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns the email address corresponding to the user's account in the specified provider, if available."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":377,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":611,"name":"phoneNumber","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The phone number normalized based on the E.164 standard (e.g. +16505550101) for the current user. This is null if the user has no phone credential linked to the account."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":381,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":612,"name":"photoURL","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns a url to the user's profile picture, if available."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":385,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":613,"name":"providerId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the unique identifier of the provider type that this instance corresponds to."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":389,"character":14}],"type":{"type":"intrinsic","name":"string"}},{"id":614,"name":"uid","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a user identifier as specified by the authentication provider."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":393,"character":7}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[609,610,611,612,613,614]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":369,"character":27}]},{"id":605,"name":"UserMetadata","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Holds the user metadata for the current {@link auth.User}.","text":"#### Example\n\n```js\nconst user = firebase.auth().currentUser;\nconsole.log('User metadata: ', user.metadata);\n```\n"},"children":[{"id":606,"name":"creationTime","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns the timestamp at which this account was created as dictated by the server clock\nas an ISO Date string."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":345,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":607,"name":"lastSignInTime","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Returns the last signin timestamp as dictated by the server clock as an ISO Date string.\nThis is only accurate up to a granularity of 2 minutes for consecutive sign-in attempts."},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":350,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[606,607]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":340,"character":31}]},{"id":830,"name":"AuthListenerCallback","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"An auth listener callback function for {@link auth#onAuthStateChanged}.","text":"#### Example\n\n```js\nfunction listener(user) {\n  if (user) {\n    // Signed in\n  } else {\n    // Signed out\n  }\n}\n\nfirebase.auth().onAuthStateChanged(listener);\n```\n"},"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":645,"character":34}],"type":{"type":"reflection","declaration":{"id":831,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":832,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":833,"name":"user","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"reference","name":"User","id":699},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":645,"character":36}]}}}],"groups":[{"title":"Classes","kind":128,"children":[746]},{"title":"Interfaces","kind":256,"children":[640,637,645,633,643,597,557,561,693,628,568,615,656,661,651,582,587,625,699,602,608,605]},{"title":"Type aliases","kind":4194304,"children":[830]}],"sources":[{"fileName":"packages/auth/lib/index.d.ts","line":51,"character":34}]},{"id":841,"name":"FirebaseCrashlyticsTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Crashlytics package for React Native.","text":"#### Example: Access the firebase export from the `crashlytics` package:\n\n```js\nimport { firebase } from '@react-native-firebase/crashlytics';\n\n// firebase.crashlytics().X\n```\n\n#### Example: Using the default export from the `crashlytics` package:\n\n```js\nimport crashlytics from '@react-native-firebase/crashlytics';\n\n// crashlytics().X\n```\n\n#### Example: Using the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/crashlytics';\n\n// firebase.crashlytics().X\n```\n","tags":[{"tag":"firebase","text":"crashlytics\n"}]},"children":[{"id":843,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Crashlytics service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Crashlytics service for the default app:\n\n```js\nconst defaultAppCrashlytics = firebase.crashlytics();\n```\n"},"children":[{"id":875,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":844,"name":"isCrashlyticsCollectionEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Whether Crashlytics reporting is enabled.","text":"#### Example\n\n```js\nconst isEnabled = firebase.crashlytics().isCrashlyticsCollectionEnabled;\n```\n\n"},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":79,"character":34}],"type":{"type":"intrinsic","name":"true"}},{"id":845,"name":"crash","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":846,"name":"crash","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Cause your app to crash for testing purposes. This is a native crash and will not contain a javascript stack trace.","text":"#### Example\n\n```js\nfirebase.crashlytics().crash();\n```\n\n"},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":91,"character":9}]},{"id":847,"name":"log","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":848,"name":"log","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Log a message that will appear in any subsequent Crash or Non-fatal error reports.","text":"#### Example\n\n```js\nfirebase.crashlytics().log('Testing a crash');\nfirebase.crashlytics().crash();\n```\n"},"parameters":[{"id":849,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":105,"character":7}]},{"id":850,"name":"recordError","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":851,"name":"recordError","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Record a JavaScript Error.","text":"The JavaScript stack trace is converted into a mock native iOS or Android exception before submission.\nThe line numbers in the stack trace (if available) will be relative to the javascript bundle built by your packager,\nafter whatever transpilation or minimization steps happen. You will need to maintain sourcemaps to decode them if desired.\n\n#### Example\n\n```js\nfirebase.crashlytics().recordError(\n new Error('An error was caught')\n);\n```\n"},"parameters":[{"id":852,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Expects an instance of Error; e.g. classes that extend Error will also be supported.\n"},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":124,"character":15}]},{"id":862,"name":"setAttribute","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":863,"name":"setAttribute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a string value to be associated with the given attribute name which will be visible in the Firebase Crashlytics console.","text":"#### Example\n\n```js\nawait firebase.crashlytics().setAttribute('role', 'admin');\n```\n"},"parameters":[{"id":864,"name":"name","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The name of the attribute to set."},"type":{"type":"intrinsic","name":"string"}},{"id":865,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A string value for the given attribute.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":189,"character":16}]},{"id":866,"name":"setAttributes","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":867,"name":"setAttributes","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Like `setAttribute` but for multiple attributes.","text":"#### Example\n\n```js\nawait firebase.crashlytics().setAttributes({\n  role: 'admin',\n  followers: '13',\n});\n```\n"},"parameters":[{"id":868,"name":"attributes","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object of key/value attribute name and values.\n"},"type":{"type":"reflection","declaration":{"id":869,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":870,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":871,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":205,"character":29}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":205,"character":17}]},{"id":872,"name":"setCrashlyticsCollectionEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":873,"name":"setCrashlyticsCollectionEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Enable/disable Crashlytics reporting.","text":"Use this for opt-in first user data collection flows combined with `firebase.json` settings to disable auto collection.\n\n#### Example\n\n```js\n// Disable crash reporting\nawait firebase.crashlytics().setCrashlyticsCollectionEnabled(false);\n```\n"},"parameters":[{"id":874,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A boolean value representing whether to enable Crashlytics error collection.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":221,"character":35}]},{"id":859,"name":"setUserEmail","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":860,"name":"setUserEmail","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Optionally specify a user email which will be visible in the Firebase Crashlytics console.","text":"If you choose to collect contact information it is strongly recommend that you disclose this in your apps privacy policy.\n\n#### Example\n\n```js\nfirebase.crashlytics().setUserEmail('user@gmail.com');\n```\n"},"parameters":[{"id":861,"name":"userEmail","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A users email address.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":175,"character":16}]},{"id":853,"name":"setUserId","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":854,"name":"setUserId","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Specify a user identifier which will be visible in the Firebase Crashlytics console.","text":"It is recommended for privacy purposes that this value be a value that's meaningless to a third-party\nobserver; such as an arbitrary string that ties an end-user to a record in your system e.g. a database record id.\n\n#### Example\n\n```js\n// Custom user id\nawait firebase.crashlytics().setUserId('123456789');\n// Firebase auth uid\nawait firebase.crashlytics().setUserId(\n firebase.auth().currentUser.uid\n);\n```\n"},"parameters":[{"id":855,"name":"userId","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An arbitrary string that ties an end-user to a record in your system e.g. a database record id.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":145,"character":13}]},{"id":856,"name":"setUserName","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":857,"name":"setUserName","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Optionally specify a user name which will be visible in the Firebase Crashlytics console.","text":"If you choose to collect contact information it is strongly recommend that you disclose this in your apps privacy policy.\n\n#### Example\n\n```js\nawait firebase.crashlytics().setUserName('Alias');\n```\n"},"parameters":[{"id":858,"name":"userName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A string representing an end-user's name or app username\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":160,"character":15}]}],"groups":[{"title":"Properties","kind":1024,"children":[875,844]},{"title":"Methods","kind":2048,"children":[845,847,850,862,866,872,859,853,856]}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":68,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":842,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":53,"character":26}]}],"groups":[{"title":"Classes","kind":128,"children":[843]},{"title":"Interfaces","kind":256,"children":[842]}],"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":50,"character":41}]},{"id":886,"name":"FirebaseDatabaseTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Database package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `database` package:\n\n```js\nimport { firebase } from '@react-native-firebase/database';\n\n// firebase.database().X\n```\n\n#### Example 2\n\nUsing the default export from the `database` package:\n\n```js\nimport database from '@react-native-firebase/database';\n\n// database().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/database';\n\n// firebase.database().X\n```\n","tags":[{"tag":"firebase","text":"database\n"}]},"children":[{"id":1185,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Database service is available for the default app or a given app.","text":"#### Example 1\n\nGet the database instance for the **default app**:\n\n```js\nconst databaseForDefaultApp = firebase.database();\n```\n\n#### Example 2\n\nGet the database instance for a **secondary app**:\n\n```js\nconst otherApp = firebase.app('otherApp');\nconst databaseForOtherApp = firebase.database(otherApp);\n```\n\n"},"children":[{"id":1207,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":1186,"name":"getServerTime","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1187,"name":"getServerTime","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the current Firebase Database server time as a JavaScript Date object."},"type":{"type":"reference","name":"Date"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1085,"character":17}]},{"id":1196,"name":"goOffline","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1197,"name":"goOffline","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Disconnects from the server (all Database operations will be completed offline).","text":"The client automatically maintains a persistent connection to the Database server, which\nwill remain active indefinitely and reconnect when disconnected. However, the `goOffline()` and\n`goOnline()` methods may be used to control the client connection in cases where a persistent\nconnection is undesirable.\n\nWhile offline, the client will no longer receive data updates from the Database. However,\nall Database operations performed locally will continue to immediately fire events, allowing\nyour application to continue behaving normally. Additionally, each operation performed locally\nwill automatically be queued and retried upon reconnection to the Database server.\n\nTo reconnect to the Database and begin receiving remote events, see `goOnline()`.\n\n#### Example\n\n```js\nawait firebase.database().goOnline();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1159,"character":13}]},{"id":1194,"name":"goOnline","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1195,"name":"goOnline","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Reconnects to the server and synchronizes the offline Database state with the server state.","text":"This method should be used after disabling the active connection with `goOffline()`. Once\nreconnected, the client will transmit the proper data and fire the appropriate events so that\nyour client \"catches up\" automatically.\n\n#### Example\n\n```js\nawait firebase.database().goOnline();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1136,"character":12}]},{"id":1188,"name":"ref","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1189,"name":"ref","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a `Reference` representing the location in the Database corresponding to the provided path.\nIf no path is provided, the Reference will point to the root of the Database.","text":"#### Example\n\n```js\n// Get a reference to the root of the Database\nconst rootRef = firebase.database().ref();\n\n// Get a reference to the /users/ada node\nconst adaRef = firebase.database().ref(\"users/ada\");\n```\n"},"parameters":[{"id":1190,"name":"path","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional path representing the location the returned `Reference` will point. If not provided, the returned `Reference` will point to the root of the Database.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Reference","id":894}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1103,"character":7}]},{"id":1191,"name":"refFromURL","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1192,"name":"refFromURL","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a `Reference` representing the location in the Database corresponding to the provided Firebase URL.","text":"An exception is thrown if the URL is not a valid Firebase Database URL or it has a different domain than the current Database instance.\n\nNote that all query parameters (orderBy, limitToLast, etc.) are ignored and are not applied to the returned Reference.\n\n#### Example\n\n```js\n// Get a reference to the root of the Database\nconst rootRef = firebase.database().ref(\"https://<DATABASE_NAME>.firebaseio.com\");\n```\n"},"parameters":[{"id":1193,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The Firebase URL at which the returned Reference will point.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Reference","id":894}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1121,"character":14}]},{"id":1201,"name":"setLoggingEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1202,"name":"setLoggingEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the native logging level for the database module. By default,\nonly warnings and errors are logged natively. Setting this to true will log all\ndatabase events.","text":"> Ensure logging is disabled for production apps, as excessive logging can cause performance issues.\n\n#### Example\n\n```js\n// Set debug logging if developing\nif (__DEV__) {\n  firebase.database().setLoggingEnabled(true);\n}\n```\n"},"parameters":[{"id":1203,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Whether debug logging is enabled.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1201,"character":21}]},{"id":1204,"name":"setPersistenceCacheSizeBytes","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1205,"name":"setPersistenceCacheSizeBytes","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"By default Firebase Database will use up to 10MB of disk space to cache data. If the cache grows beyond this size,\nFirebase Database will start removing data that hasn't been recently used. If you find that your application\ncaches too little or too much data, call this method to change the cache size. This method must be called before\ncreating your first Database reference and only needs to be called once per application.","text":"Note that the specified cache size is only an approximation and the size on disk may temporarily exceed it at times.\nCache sizes smaller than 1 MB or greater than 100 MB are not supported.\n\n#### Example\n\n```js\nfirebase.database().setPersistenceEnabled(true);\nfirebase.database().setPersistenceCacheSizeBytes(2000000); // 2MB\n\nasync function bootstrap() {\n  // Bootstrapping application\n  const snapshot = await firebase.database().ref('settings').once('value');\n}\n```\n"},"parameters":[{"id":1206,"name":"bytes","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new size of the cache in bytes.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1226,"character":32}]},{"id":1198,"name":"setPersistenceEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1199,"name":"setPersistenceEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets whether persistence is enabled for all database calls for the current app\ninstance.","text":"> Ensure this is called before any database calls are performed, otherwise\npersistence will only come into effect when the app is next started.\n\n#### Example\n\n```js\nfirebase.database().setPersistenceEnabled(true);\n\nasync function bootstrap() {\n  // Bootstrapping application\n  const snapshot = await firebase.database().ref('settings').once('value');\n}\n```\n"},"parameters":[{"id":1200,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Whether persistence is enabled for the Database service.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1181,"character":25}]}],"groups":[{"title":"Properties","kind":1024,"children":[1207]},{"title":"Methods","kind":2048,"children":[1186,1196,1194,1188,1191,1201,1204,1198]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1081,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":1159,"name":"DataSnapshot","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `DataSnapshot` contains data from a Database location.","text":"Any time you read data from the Database, you receive the data as a `DataSnapshot`. A `DataSnapshot`\nis passed to the event callbacks you attach with `on()` or `once()`. You can extract the contents\nof the snapshot as a JavaScript object by calling the val() method. Alternatively, you can traverse\ninto the snapshot by calling `child()` to return child snapshots (which you could then call `val()` on).\n"},"children":[{"id":1160,"name":"key","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The key (last part of the path) of the location of this `DataSnapshot`.","text":"The last token in a Database location is considered its key. For example, \"ada\" is the key\nfor the /users/ada/ node. Accessing the key on any `DataSnapshot` will return the key for the\nlocation that generated it. However, accessing the key on the root URL of a Database will return `null`.\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":923,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":1161,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Reference for the location that generated this `DataSnapshot`."},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":928,"character":7}],"type":{"type":"reference","name":"Reference","id":894}},{"id":1162,"name":"child","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1163,"name":"child","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets another `DataSnapshot` for the location at the specified relative path.","text":"Passing a relative path to the `child()` method of a DataSnapshot returns another `DataSnapshot`\nfor the location at the specified relative path. The relative path can either be a simple child\nname (for example, \"ada\") or a deeper, slash-separated path (for example, \"ada/name/first\").\nIf the child location has no data, an empty `DataSnapshot` (that is, a `DataSnapshot` whose value\nis `null`) is returned.\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users/ada').once('value');\nsnapshot.child('name').val(); // {first:\"Ada\",last:\"Lovelace\"}\nsnapshot.child('name/first').val(); // \"Ada\"\nsnapshot.child('name/foo').val(); // null\n```\n"},"parameters":[{"id":1164,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A relative path to the location of child data.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"DataSnapshot","id":1159}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":950,"character":9}]},{"id":1165,"name":"exists","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1166,"name":"exists","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `DataSnapshot` contains any data. It is slightly more efficient than using snapshot.val() !== null.","text":"#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users/ada').once('value');\nsnapshot.exists(); // true\nsnapshot.child('name/foo').exists(); // false\n```\n"},"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":963,"character":10}]},{"id":1167,"name":"exportVal","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1168,"name":"exportVal","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Exports the entire contents of the DataSnapshot as a JavaScript object.","text":"The `exportVal()` method is similar to val(), except priority information is included (if available),\nmaking it suitable for backing up your data.\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users/ada').once('value');\nconst data = snapshot.exportVal();\nconsole.log(data['.value']); // { ... }\nconsole.log(data['.priority']); // null\n```\n"},"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":980,"character":13}]},{"id":1169,"name":"forEach","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1170,"name":"forEach","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Enumerates the top-level children in the `DataSnapshot`.","text":"Because of the way JavaScript objects work, the ordering of data in the JavaScript object\nreturned by `val()` is not guaranteed to match the ordering on the server nor the ordering\nof `child_added` events. That is where `forEach()` comes in handy. It guarantees the children of\na DataSnapshot will be iterated in their query order.\n\nIf no explicit `orderBy*()` method is used, results are returned ordered by key (unless priorities are used, in which case, results are returned by priority).\n"},"parameters":[{"id":1171,"name":"action","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A function that will be called for each child DataSnapshot. The callback can return true to cancel further enumeration.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":994,"character":11}]},{"id":1172,"name":"getPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1173,"name":"getPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the priority value of the data in this DataSnapshot."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":999,"character":15}]},{"id":1174,"name":"hasChild","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1175,"name":"hasChild","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if the specified child path has (non-null) data.","text":"#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users/ada').once('value');\nconsole.log(snapshot.hasChild('name')); // true\nconsole.log(snapshot.hasChild('foo')); // false\n```\n"},"parameters":[{"id":1176,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A relative path to the location of a potential child.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1014,"character":12}]},{"id":1177,"name":"hasChildren","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1178,"name":"hasChildren","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns whether or not the `DataSnapshot` has any non-null child properties.","text":"You can use `hasChildren()` to determine if a `DataSnapshot` has any children. If it does, you\ncan enumerate them using `forEach()`. If it doesn't, then either this snapshot contains a primitive\nvalue (which can be retrieved with `val()`) or it is empty (in which case, `val()` will return null).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').once('value');\nconsole.log(snapshot.hasChildren()); // true\n```\n"},"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1030,"character":15}]},{"id":1179,"name":"numChildren","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1180,"name":"numChildren","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the number of child properties of this DataSnapshot."},"type":{"type":"intrinsic","name":"number"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1035,"character":15}]},{"id":1181,"name":"toJSON","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1182,"name":"toJSON","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a JSON-serializable representation of this object."},"type":{"type":"union","types":[{"type":"intrinsic","name":"object"},{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1040,"character":10}]},{"id":1183,"name":"val","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1184,"name":"val","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Extracts a JavaScript value from a `DataSnapshot`.","text":"Depending on the data in a DataSnapshot, the `val()` method may return a scalar type (string,\nnumber, or boolean), an array, or an object. It may also return null, indicating that the\n`DataSnapshot` is empty (contains no data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users/ada/last').once('value');\nsnapshot.val(); // \"Lovelace\"\n```\n"},"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1056,"character":7}]}],"groups":[{"title":"Properties","kind":1024,"children":[1160,1161]},{"title":"Methods","kind":2048,"children":[1162,1165,1167,1169,1172,1174,1177,1179,1181,1183]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":915,"character":31}]},{"id":1136,"name":"OnDisconnect","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The `onDisconnect` class allows you to write or clear data when your client disconnects from the Database server.\nThese updates occur whether your client disconnects cleanly or not, so you can rely on them to clean up data\neven if a connection is dropped or a client crashes.","text":"The onDisconnect class is most commonly used to manage presence in applications where it is\nuseful to detect how many clients are connected and when other clients disconnect.\n\nTo avoid problems when a connection is dropped before the requests can be transferred to the Database\nserver, these functions should be called before writing any data.\n\nNote that `onDisconnect` operations are only triggered once. If you want an operation to occur each time a\ndisconnect occurs, you'll need to re-establish the `onDisconnect` operations each time you reconnect.\n"},"children":[{"id":1137,"name":"cancel","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1138,"name":"cancel","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Cancels all previously queued `onDisconnect()` set or update events for this location and all children.","text":"If a write has been queued for this location via a `set()` or `update()` at a parent location,\nthe write at this location will be canceled, though writes to sibling locations will still occur.\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('onlineState');\nawait ref.onDisconnect().set(false);\n// Sometime later...\nawait ref.onDisconnect().cancel();\n```\n"},"parameters":[{"id":1139,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback function that will be called when synchronization to the server has completed. The callback will be passed a single parameter: null for success, or an Error object indicating a failure.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":826,"character":10}]},{"id":1140,"name":"remove","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1141,"name":"remove","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Ensures the data at this location is deleted when the client is disconnected (due to closing the browser, navigating to a new page, or network issues)."},"parameters":[{"id":1142,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback function that will be called when synchronization to the server has completed. The callback will be passed a single parameter: null for success, or an Error object indicating a failure.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":833,"character":10}]},{"id":1143,"name":"set","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1144,"name":"set","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Ensures the data at this location is set to the specified value when the client is disconnected\n(due to closing the app, navigating to a new view, or network issues).","text":"`set()` is especially useful for implementing \"presence\" systems, where a value should be changed\nor cleared when a user disconnects so that they appear \"offline\" to other users.\n\nNote that `onDisconnect` operations are only triggered once. If you want an operation to occur each time a\ndisconnect occurs, you'll need to re-establish the `onDisconnect` operations each time.\n\n#### Example\n\n```js\nvar ref = firebase.database().ref('users/ada/status');\nawait ref.onDisconnect().set('I disconnected!');\n```\n"},"parameters":[{"id":1145,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to be written to this location on disconnect (can be an object, array, string, number, boolean, or null)."},"type":{"type":"intrinsic","name":"any"}},{"id":1146,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback function that will be called when synchronization to the Database server has completed. The callback will be passed a single parameter: null for success, or an Error object indicating a failure.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":855,"character":7}]},{"id":1147,"name":"setWithPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1148,"name":"setWithPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Ensures the data at this location is set to the specified value and priority when the client is disconnected (due to closing the browser, navigating to a new page, or network issues)."},"parameters":[{"id":1149,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to set."},"type":{"type":"intrinsic","name":"any"}},{"id":1150,"name":"priority","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The priority to set"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}},{"id":1151,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback function that will be called when synchronization to the Database server has completed. The callback will be passed a single parameter: null for success, or an Error object indicating a failure.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":864,"character":19}]},{"id":1152,"name":"update","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1153,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes multiple values at this location when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).","text":"The `values` argument contains multiple property-value pairs that will be written to the Database together.\nEach child property can either be a simple property (for example, \"name\") or a relative path (for example,\n\"name/first\") from the current location to the data to update.\n\nAs opposed to the `set()` method, `update()` can be use to selectively update only the referenced\nproperties at the current location (instead of replacing all the child properties at the current location).\n\n#### Example\n\n```js\nvar ref = firebase.database().ref(\"users/ada\");\nref.update({\n  onlineState: true,\n  status: \"I'm online.\"\n});\nref.onDisconnect().update({\n  onlineState: false,\n  status: \"I'm offline.\"\n});\n```\n"},"parameters":[{"id":1154,"name":"values","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Object containing multiple values."},"type":{"type":"reflection","declaration":{"id":1155,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1156,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1157,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":897,"character":18}]}}},{"id":1158,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback function that will be called when synchronization to the server has completed. The callback will be passed a single parameter: null for success, or an Error object indicating a failure.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":897,"character":10}]}],"groups":[{"title":"Methods","kind":2048,"children":[1137,1140,1143,1147,1152]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":808,"character":31}]},{"id":1082,"name":"Query","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A Query sorts and filters the data at a Database location so only a subset of the child data\nis included. This can be used to order a collection of data by some attribute (for example,\nheight of dinosaurs) as well as to restrict a large list of items (for example, chat messages)\ndown to a number suitable for synchronizing to the client. Queries are created by chaining\ntogether one or more of the filter methods defined here.","text":"Just as with a `Reference`, you can receive data from a Query by using the on() method. You will\nonly receive events and `DataSnapshot`s for the subset of the data that matches your query.\n"},"children":[{"id":1083,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a Reference to the Query's location."},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":423,"character":7}],"type":{"type":"reference","name":"Reference","id":894}},{"id":1084,"name":"endAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1085,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Query with the specified ending point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe ending point is inclusive, so children with exactly the specified value will be included\nin the query. The optional key argument can be used to further limit the range of the query.\nIf it is specified, then children that have exactly the specified value must also have a key\nname less than or equal to the specified key.\n\nYou can read more about endAt() in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nconst snapshot = await ref.orderByKey().endAt('Ada Lovelace').once('value');\n```\n"},"parameters":[{"id":1086,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to end at. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":1087,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":448,"character":9}]},{"id":1088,"name":"equalTo","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1089,"name":"equalTo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Query with the specified ending point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe optional key argument can be used to further limit the range of the query. If it is\nspecified, then children that have exactly the specified value must also have exactly the\nspecified key as their key name. This can be used to filter result sets with many matches for the same value.\n\nYou can read more about equalTo() in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nconst snapshot = await ref.orderByChild('age').equalTo(30).once('value');\n```\n"},"parameters":[{"id":1090,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to match for. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":1091,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":472,"character":11}]},{"id":1092,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1093,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns whether or not the current and provided queries represent the same location, have the same query parameters.","text":"Two Reference objects are equivalent if they represent the same location and are from the same instance of\n{@link app}.  Equivalent queries share the same sort order, limits, and starting and ending points.\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref('users').orderByKey().endAt('Ada Lovelace');\nconst ref2 = firebase.database().ref('users').orderByKey();\n\nconsole.log(ref1.isEqual(ref2)); // false\n```\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref('users').orderByKey().endAt('Ada Lovelace');\nconst ref2 = firebase.database().ref('users').endAt('Ada Lovelace').orderByKey();\n\nconsole.log(ref1.isEqual(ref2)); // true\n```\n"},"parameters":[{"id":1094,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The query to compare against.\n"},"type":{"type":"reference","name":"Query","id":1082}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":500,"character":11}]},{"id":1133,"name":"keepSynced","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1134,"name":"keepSynced","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"By calling `keepSynced(true)` on a location, the data for that location will automatically\nbe downloaded and kept in sync, even when no listeners are attached for that location.","text":"#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nawait ref.keepSynced(true);\n```\n"},"parameters":[{"id":1135,"name":"bool","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Pass `true` to keep this location synchronized, pass `false` to stop synchronization.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":791,"character":14}]},{"id":1095,"name":"limitToFirst","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1096,"name":"limitToFirst","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` limited to the first specific number of children.","text":"The `limitToFirst()` method is used to set a maximum number of children to be synced for a\ngiven callback. If we set a limit of 100, we will initially only receive up to 100 `child_added`\nevents. If we have fewer than 100 messages stored in our Database, a child_added event will\nfire for each message. However, if we have over 100 messages, we will only receive a `child_added`\nevent for the first 100 ordered messages. As items change, we will receive `child_removed` events\nfor each item that drops out of the active list so that the total number stays at 100.\n\nYou can read more about `limitToFirst()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst snapshot = firebase.database().ref('users').orderByKey().limitToFirst(2).once('value');\nconsole.log(snapshot.numChildren()); // 2\n```\n"},"parameters":[{"id":1097,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of nodes to include in this query.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":523,"character":16}]},{"id":1098,"name":"limitToLast","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1099,"name":"limitToLast","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object limited to the last specific number of children.","text":"The `limitToLast()` method is used to set a maximum number of children to be synced for a given\ncallback. If we set a limit of 100, we will initially only receive up to 100 `child_added` events.\nIf we have fewer than 100 messages stored in our Database, a `child_added` event will fire for\neach message. However, if we have over 100 messages, we will only receive a `child_added` event\nfor the last 100 ordered messages. As items change, we will receive `child_removed` events for\neach item that drops out of the active list so that the total number stays at 100.\n\nYou can read more about `limitToLast()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst snapshot = firebase.database().ref('users').orderByKey().limitToLast(2).once('value');\nconsole.log(snapshot.numChildren()); // 2\n```\n"},"parameters":[{"id":1100,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of nodes to include in this query.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":546,"character":15}]},{"id":1101,"name":"off","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1102,"name":"off","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detaches a callback previously attached with `on()`.","text":"Detach a callback previously attached with `on()`. Note that if `on()` was called multiple times\nwith the same eventType and callback, the callback will be called multiple times for each\nevent, and `off()` must be called multiple times to remove the callback. Calling `off()` on a parent\nlistener will not automatically remove listeners registered on child nodes, `off()` must also be\ncalled on any child listeners to remove the callback.\n\nIf a callback is not specified, all callbacks for the specified eventType will be removed.\nSimilarly, if no eventType is specified, all callbacks for the `Reference` will be removed.\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('settings');\nconst onValueChange = function(snapshot) { ... };\nconst onChildAdded = function(snapshot) { ... };\n\nref.on('value', onValueChange);\nref.child('meta-data').on('child_added', onChildAdded);\n// Sometime later...\nref.off('value', onValueChange);\nref.child('meta-data').off('child_added', onChildAdded);\n```\n"},"parameters":[{"id":1103,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\" If omitted, all callbacks for the Reference will be removed."},"type":{"type":"reference","name":"EventType","id":1208}},{"id":1104,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The callback function that was passed to `on()` or `undefined` to remove all callbacks."},"type":{"type":"reference","name":"Function"}},{"id":1105,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The context that was passed to `on()`.\n"},"type":{"type":"reference","name":"Object"}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":578,"character":7}]},{"id":1106,"name":"on","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1107,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listens for data changes at a particular location.","text":"This is the primary way to read data from a Database. Your callback will be triggered for the\ninitial data and again whenever the data changes. Use `off()` to stop receiving updates..\n\n**value** event\n\nThis event will trigger once with the initial data stored at this location, and then trigger\nagain each time the data changes. The `DataSnapshot` passed to the callback will be for the location\nat which on() was called. It won't trigger until the entire contents has been synchronized.\nIf the location has no data, it will be triggered with an empty `DataSnapshot`\n(`val()` will return `null`).\n\n**child_added** event\n\nThis event will be triggered once for each initial child at this location, and it will be\ntriggered again every time a new child is added. The `DataSnapshot` passed into the callback\nwill reflect the data for the relevant child. For ordering purposes, it is passed a second argument\nwhich is a string containing the key of the previous sibling child by sort order, or `null` if\nit is the first child.\n\n**child_removed** event\n\nThis event will be triggered once every time a child is removed. The `DataSnapshot` passed into\nthe callback will be the old data for the child that was removed. A child will get removed when either:\n- a client explicitly calls `remove()` on that child or one of its ancestors\n- a client calls `set(null)` on that child or one of its ancestors\n- that child has all of its children removed\n- there is a query in effect which now filters out the child (because it's sort order changed or the max limit was hit)\n\n**child_changed** event\n\nThis event will be triggered when the data stored in a child (or any of its descendants) changes.\nNote that a single `child_changed` event may represent multiple changes to the child. The\n`DataSnapshot` passed to the callback will contain the new child contents. For ordering purposes,\nthe callback is also passed a second argument which is a string containing the key of the previous\nsibling child by sort order, or `null` if it is the first child.\n\n**child_moved** event\n\nThis event will be triggered when a child's sort order changes such that its position relative\nto its siblings changes. The `DataSnapshot` passed to the callback will be for the data of the child\nthat has moved. It is also passed a second argument which is a string containing the key of the\nprevious sibling child by sort order, or `null` if it is the first child.\n"},"parameters":[{"id":1108,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\""},"type":{"type":"reference","name":"EventType","id":1208}},{"id":1109,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback that fires when the specified event occurs. The callback will be passed a DataSnapshot. For ordering purposes, \"child_added\", \"child_changed\", and \"child_moved\" will also be passed a string containing the key of the previous child, by sort order, or `null` if it is the first child."},"type":{"type":"reference","name":"Function"}},{"id":1110,"name":"cancelCallbackOrContext","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback that will be notified if your event subscription is ever canceled because your client does not have permission to read this data (or it had permission but has now lost it). This callback will be passed an `Error` object indicating why the failure occurred."},"type":{"type":"reference","name":"Object"}},{"id":1111,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"If provided, this object will be used as `this` when calling your callback(s).\n\n"},"type":{"type":"union","types":[{"type":"reference","name":"Object"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Function"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":632,"character":6}]},{"id":1112,"name":"once","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1113,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listens for exactly one event of the specified event type, and then stops listening.","text":"This is equivalent to calling `on()`, and then calling `off()` inside the callback function. See `on()` for details on the event types.\n\n#### Example\n\n```js\n// Promise\nconst snapshot = await firebase.database().ref('users').once('value');\n// Callback\nfirebase.database().ref('users).once('value', (snapshot) => {\n  console.log(snapshot.val());\n});\n```\n"},"parameters":[{"id":1114,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\""},"type":{"type":"reference","name":"EventType","id":1208}},{"id":1115,"name":"successCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback that fires when the specified event occurs. The callback will be passed a DataSnapshot. For ordering purposes, \"child_added\", \"child_changed\", and \"child_moved\" will also be passed a string containing the key of the previous child by sort order, or `null` if it is the first child.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"DataSnapshot","id":1159}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":658,"character":8}]},{"id":1116,"name":"orderByChild","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1117,"name":"orderByChild","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by the specified child key.","text":"Queries can only order by one key at a time. Calling `orderByChild()` multiple times on the same query is an error.\n\nFirebase queries allow you to order your data by any child key on the fly. However, if you know in advance what\nyour indexes will be, you can define them via the [.indexOn](https://firebase.google.com/docs/database/security/indexing-data?authuser=0)\nrule in your Security Rules for better performance.\n\nYou can read more about orderByChild() in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').orderByChild('age').once('value');\nsnapshot.forEach((snapshot) => {\n console.log('Users age:', snapshot.val().age);\n});\n```\n"},"parameters":[{"id":1118,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The child path node to order by.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":682,"character":16}]},{"id":1119,"name":"orderByKey","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1120,"name":"orderByKey","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by key.","text":"Sorts the results of a query by their (ascending) key values.\n\nYou can read more about `orderByKey()` in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').orderByKey().once('value');\nsnapshot.forEach((snapshot) => {\n console.log('User:', snapshot.val());\n});\n```\n"},"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":700,"character":14}]},{"id":1121,"name":"orderByPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1122,"name":"orderByPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new Query object ordered by priority.","text":"Applications need not use priority but can order collections by ordinary properties\n(see [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data)\nfor alternatives to priority).\n"},"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":709,"character":19}]},{"id":1123,"name":"orderByValue","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1124,"name":"orderByValue","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by value.","text":"If the children of a query are all scalar values (string, number, or boolean), you can order\nthe results by their (ascending) values.\n\nYou can read more about `orderByValue()` in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nawait firebase.database().ref('scores').orderByValue().once('value');\n```\n"},"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":725,"character":16}]},{"id":1125,"name":"startAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1126,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a `Query` with the specified starting point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe starting point is inclusive, so children with exactly the specified value will be included\nin the query. The optional key argument can be used to further limit the range of the query.\nIf it is specified, then children that have exactly the specified value must also have a key\nname greater than or equal to the specified key.\n\nYou can read more about `startAt()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nawait firebase.database().ref('users').orderByChild('age').startAt(21).once('value');\n```\n"},"parameters":[{"id":1127,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to start at. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":1128,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to start at. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":749,"character":11}]},{"id":1129,"name":"toJSON","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1130,"name":"toJSON","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a JSON-serializable representation of this object."},"type":{"type":"intrinsic","name":"object"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":754,"character":10}]},{"id":1131,"name":"toString","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1132,"name":"toString","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the absolute URL for this location.","text":"The `toString()` method returns a URL that is ready to be put into a browser, curl command, or\na `firebase.database().refFromURL()` call. Since all of those expect the URL to be url-encoded,\n`toString()` returns an encoded URL.\n\nAppend '.json' to the returned URL when typed into a browser to download JSON-formatted data.\nIf the location is secured (that is, not publicly readable), you will get a permission-denied error.\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref();\nconst ref2 = firebase.database().ref('users').orderByValue();\n\nref1.toString(); // https://sample-app.firebaseio.com/\nref2.toString(); // https://sample-app.firebaseio.com/users\n```\n"},"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":776,"character":12}]}],"groups":[{"title":"Properties","kind":1024,"children":[1083]},{"title":"Methods","kind":2048,"children":[1084,1088,1092,1133,1095,1098,1101,1106,1112,1116,1119,1121,1123,1125,1129,1131]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":419,"character":24}],"extendedBy":[{"type":"reference","name":"Reference","id":894}]},{"id":894,"name":"Reference","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A Reference represents a specific location in your Database and can be used for reading or\nwriting data to that Database location.","text":"You can reference the root or child location in your Database by calling `firebase.database().ref()`\nor `firebase.database().ref(\"child/path\")`.\n"},"children":[{"id":900,"name":"key","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The last part of the Reference's path.\nFor example, \"ada\" is the key for https://<DATABASE_NAME>.firebaseio.com/users/ada.\nThe key of a root Reference is null."},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":159,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":895,"name":"parent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The parent location of a Reference. The parent of a root Reference is `null`.","text":"#### Example\n\n```js\nfirebase.database().ref().parent; // null\nfirebase.database().ref('users/dave').parent; // 'users' reference\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":123,"character":10}],"type":{"type":"union","types":[{"type":"reference","name":"Reference","id":894},{"type":"intrinsic","name":"null"}]}},{"id":935,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a Reference to the Query's location."},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":423,"character":7}],"type":{"type":"reference","name":"Reference","id":894},"inheritedFrom":{"type":"reference","name":"Query.ref","id":1083}},{"id":896,"name":"root","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The root Reference of the Database.","text":"#### Example\n\n```js\nfirebase.database().ref().root; // '/' reference path\nfirebase.database().ref('users/ada').root; // '/' reference\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":135,"character":8}],"type":{"type":"reference","name":"Reference","id":894}},{"id":897,"name":"child","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":898,"name":"child","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a Reference for the location at the specified relative path.","text":"The relative path can either be a simple child name (for example, \"ada\") or a deeper\nslash-separated path (for example, \"ada/name/first\").\n\n#### Example\n\n```js\nconst usersRef = firebase.database().ref('users');\nconst adaRef = usersRef.child('ada/name/first'); // childRef path is 'users/ada/name/first'\n```\n"},"parameters":[{"id":899,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A relative path from this location to the desired child location.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Reference","id":894}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":152,"character":9}]},{"id":936,"name":"endAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":937,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Query with the specified ending point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe ending point is inclusive, so children with exactly the specified value will be included\nin the query. The optional key argument can be used to further limit the range of the query.\nIf it is specified, then children that have exactly the specified value must also have a key\nname less than or equal to the specified key.\n\nYou can read more about endAt() in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nconst snapshot = await ref.orderByKey().endAt('Ada Lovelace').once('value');\n```\n"},"parameters":[{"id":938,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to end at. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":939,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1084}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":448,"character":9}],"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1084}},{"id":940,"name":"equalTo","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":941,"name":"equalTo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Query with the specified ending point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe optional key argument can be used to further limit the range of the query. If it is\nspecified, then children that have exactly the specified value must also have exactly the\nspecified key as their key name. This can be used to filter result sets with many matches for the same value.\n\nYou can read more about equalTo() in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nconst snapshot = await ref.orderByChild('age').equalTo(30).once('value');\n```\n"},"parameters":[{"id":942,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to match for. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":943,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.equalTo","id":1088}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":472,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.equalTo","id":1088}},{"id":944,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":945,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns whether or not the current and provided queries represent the same location, have the same query parameters.","text":"Two Reference objects are equivalent if they represent the same location and are from the same instance of\n{@link app}.  Equivalent queries share the same sort order, limits, and starting and ending points.\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref('users').orderByKey().endAt('Ada Lovelace');\nconst ref2 = firebase.database().ref('users').orderByKey();\n\nconsole.log(ref1.isEqual(ref2)); // false\n```\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref('users').orderByKey().endAt('Ada Lovelace');\nconst ref2 = firebase.database().ref('users').endAt('Ada Lovelace').orderByKey();\n\nconsole.log(ref1.isEqual(ref2)); // true\n```\n"},"parameters":[{"id":946,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The query to compare against.\n"},"type":{"type":"reference","name":"Query","id":1082}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","name":"Query.isEqual","id":1092}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":500,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.isEqual","id":1092}},{"id":985,"name":"keepSynced","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":986,"name":"keepSynced","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"By calling `keepSynced(true)` on a location, the data for that location will automatically\nbe downloaded and kept in sync, even when no listeners are attached for that location.","text":"#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nawait ref.keepSynced(true);\n```\n"},"parameters":[{"id":987,"name":"bool","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Pass `true` to keep this location synchronized, pass `false` to stop synchronization.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Query.keepSynced","id":1133}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":791,"character":14}],"inheritedFrom":{"type":"reference","name":"Query.keepSynced","id":1133}},{"id":947,"name":"limitToFirst","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":948,"name":"limitToFirst","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` limited to the first specific number of children.","text":"The `limitToFirst()` method is used to set a maximum number of children to be synced for a\ngiven callback. If we set a limit of 100, we will initially only receive up to 100 `child_added`\nevents. If we have fewer than 100 messages stored in our Database, a child_added event will\nfire for each message. However, if we have over 100 messages, we will only receive a `child_added`\nevent for the first 100 ordered messages. As items change, we will receive `child_removed` events\nfor each item that drops out of the active list so that the total number stays at 100.\n\nYou can read more about `limitToFirst()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst snapshot = firebase.database().ref('users').orderByKey().limitToFirst(2).once('value');\nconsole.log(snapshot.numChildren()); // 2\n```\n"},"parameters":[{"id":949,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of nodes to include in this query.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.limitToFirst","id":1095}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":523,"character":16}],"inheritedFrom":{"type":"reference","name":"Query.limitToFirst","id":1095}},{"id":950,"name":"limitToLast","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":951,"name":"limitToLast","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object limited to the last specific number of children.","text":"The `limitToLast()` method is used to set a maximum number of children to be synced for a given\ncallback. If we set a limit of 100, we will initially only receive up to 100 `child_added` events.\nIf we have fewer than 100 messages stored in our Database, a `child_added` event will fire for\neach message. However, if we have over 100 messages, we will only receive a `child_added` event\nfor the last 100 ordered messages. As items change, we will receive `child_removed` events for\neach item that drops out of the active list so that the total number stays at 100.\n\nYou can read more about `limitToLast()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst snapshot = firebase.database().ref('users').orderByKey().limitToLast(2).once('value');\nconsole.log(snapshot.numChildren()); // 2\n```\n"},"parameters":[{"id":952,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of nodes to include in this query.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.limitToLast","id":1098}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":546,"character":15}],"inheritedFrom":{"type":"reference","name":"Query.limitToLast","id":1098}},{"id":953,"name":"off","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":954,"name":"off","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detaches a callback previously attached with `on()`.","text":"Detach a callback previously attached with `on()`. Note that if `on()` was called multiple times\nwith the same eventType and callback, the callback will be called multiple times for each\nevent, and `off()` must be called multiple times to remove the callback. Calling `off()` on a parent\nlistener will not automatically remove listeners registered on child nodes, `off()` must also be\ncalled on any child listeners to remove the callback.\n\nIf a callback is not specified, all callbacks for the specified eventType will be removed.\nSimilarly, if no eventType is specified, all callbacks for the `Reference` will be removed.\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('settings');\nconst onValueChange = function(snapshot) { ... };\nconst onChildAdded = function(snapshot) { ... };\n\nref.on('value', onValueChange);\nref.child('meta-data').on('child_added', onChildAdded);\n// Sometime later...\nref.off('value', onValueChange);\nref.child('meta-data').off('child_added', onChildAdded);\n```\n"},"parameters":[{"id":955,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\" If omitted, all callbacks for the Reference will be removed."},"type":{"type":"reference","name":"EventType","id":1208}},{"id":956,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The callback function that was passed to `on()` or `undefined` to remove all callbacks."},"type":{"type":"reference","name":"Function"}},{"id":957,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The context that was passed to `on()`.\n"},"type":{"type":"reference","name":"Object"}}],"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","name":"Query.off","id":1101}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":578,"character":7}],"inheritedFrom":{"type":"reference","name":"Query.off","id":1101}},{"id":958,"name":"on","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":959,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listens for data changes at a particular location.","text":"This is the primary way to read data from a Database. Your callback will be triggered for the\ninitial data and again whenever the data changes. Use `off()` to stop receiving updates..\n\n**value** event\n\nThis event will trigger once with the initial data stored at this location, and then trigger\nagain each time the data changes. The `DataSnapshot` passed to the callback will be for the location\nat which on() was called. It won't trigger until the entire contents has been synchronized.\nIf the location has no data, it will be triggered with an empty `DataSnapshot`\n(`val()` will return `null`).\n\n**child_added** event\n\nThis event will be triggered once for each initial child at this location, and it will be\ntriggered again every time a new child is added. The `DataSnapshot` passed into the callback\nwill reflect the data for the relevant child. For ordering purposes, it is passed a second argument\nwhich is a string containing the key of the previous sibling child by sort order, or `null` if\nit is the first child.\n\n**child_removed** event\n\nThis event will be triggered once every time a child is removed. The `DataSnapshot` passed into\nthe callback will be the old data for the child that was removed. A child will get removed when either:\n- a client explicitly calls `remove()` on that child or one of its ancestors\n- a client calls `set(null)` on that child or one of its ancestors\n- that child has all of its children removed\n- there is a query in effect which now filters out the child (because it's sort order changed or the max limit was hit)\n\n**child_changed** event\n\nThis event will be triggered when the data stored in a child (or any of its descendants) changes.\nNote that a single `child_changed` event may represent multiple changes to the child. The\n`DataSnapshot` passed to the callback will contain the new child contents. For ordering purposes,\nthe callback is also passed a second argument which is a string containing the key of the previous\nsibling child by sort order, or `null` if it is the first child.\n\n**child_moved** event\n\nThis event will be triggered when a child's sort order changes such that its position relative\nto its siblings changes. The `DataSnapshot` passed to the callback will be for the data of the child\nthat has moved. It is also passed a second argument which is a string containing the key of the\nprevious sibling child by sort order, or `null` if it is the first child.\n"},"parameters":[{"id":960,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\""},"type":{"type":"reference","name":"EventType","id":1208}},{"id":961,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback that fires when the specified event occurs. The callback will be passed a DataSnapshot. For ordering purposes, \"child_added\", \"child_changed\", and \"child_moved\" will also be passed a string containing the key of the previous child, by sort order, or `null` if it is the first child."},"type":{"type":"reference","name":"Function"}},{"id":962,"name":"cancelCallbackOrContext","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback that will be notified if your event subscription is ever canceled because your client does not have permission to read this data (or it had permission but has now lost it). This callback will be passed an `Error` object indicating why the failure occurred."},"type":{"type":"reference","name":"Object"}},{"id":963,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"If provided, this object will be used as `this` when calling your callback(s).\n\n"},"type":{"type":"union","types":[{"type":"reference","name":"Object"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Function"},"inheritedFrom":{"type":"reference","name":"Query.on","id":1106}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":632,"character":6}],"inheritedFrom":{"type":"reference","name":"Query.on","id":1106}},{"id":933,"name":"onDisconnect","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":934,"name":"onDisconnect","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an {@link database.OnDisconnect} instance.","text":"#### Example\n\n```js\nconst userDisconnectRef = firebase.database().ref('users/ada/isOnline').onDisconnect();\n// When going offline\nawait userDisconnectRef.update(false);\n```\n"},"type":{"type":"reference","name":"OnDisconnect","id":1136}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":404,"character":16}]},{"id":964,"name":"once","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":965,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listens for exactly one event of the specified event type, and then stops listening.","text":"This is equivalent to calling `on()`, and then calling `off()` inside the callback function. See `on()` for details on the event types.\n\n#### Example\n\n```js\n// Promise\nconst snapshot = await firebase.database().ref('users').once('value');\n// Callback\nfirebase.database().ref('users).once('value', (snapshot) => {\n  console.log(snapshot.val());\n});\n```\n"},"parameters":[{"id":966,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\""},"type":{"type":"reference","name":"EventType","id":1208}},{"id":967,"name":"successCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback that fires when the specified event occurs. The callback will be passed a DataSnapshot. For ordering purposes, \"child_added\", \"child_changed\", and \"child_moved\" will also be passed a string containing the key of the previous child by sort order, or `null` if it is the first child.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"DataSnapshot","id":1159}]},"inheritedFrom":{"type":"reference","name":"Query.once","id":1112}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":658,"character":8}],"inheritedFrom":{"type":"reference","name":"Query.once","id":1112}},{"id":968,"name":"orderByChild","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":969,"name":"orderByChild","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by the specified child key.","text":"Queries can only order by one key at a time. Calling `orderByChild()` multiple times on the same query is an error.\n\nFirebase queries allow you to order your data by any child key on the fly. However, if you know in advance what\nyour indexes will be, you can define them via the [.indexOn](https://firebase.google.com/docs/database/security/indexing-data?authuser=0)\nrule in your Security Rules for better performance.\n\nYou can read more about orderByChild() in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').orderByChild('age').once('value');\nsnapshot.forEach((snapshot) => {\n console.log('Users age:', snapshot.val().age);\n});\n```\n"},"parameters":[{"id":970,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The child path node to order by.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByChild","id":1116}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":682,"character":16}],"inheritedFrom":{"type":"reference","name":"Query.orderByChild","id":1116}},{"id":971,"name":"orderByKey","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":972,"name":"orderByKey","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by key.","text":"Sorts the results of a query by their (ascending) key values.\n\nYou can read more about `orderByKey()` in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').orderByKey().once('value');\nsnapshot.forEach((snapshot) => {\n console.log('User:', snapshot.val());\n});\n```\n"},"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByKey","id":1119}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":700,"character":14}],"inheritedFrom":{"type":"reference","name":"Query.orderByKey","id":1119}},{"id":973,"name":"orderByPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":974,"name":"orderByPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new Query object ordered by priority.","text":"Applications need not use priority but can order collections by ordinary properties\n(see [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data)\nfor alternatives to priority).\n"},"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByPriority","id":1121}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":709,"character":19}],"inheritedFrom":{"type":"reference","name":"Query.orderByPriority","id":1121}},{"id":975,"name":"orderByValue","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":976,"name":"orderByValue","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by value.","text":"If the children of a query are all scalar values (string, number, or boolean), you can order\nthe results by their (ascending) values.\n\nYou can read more about `orderByValue()` in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nawait firebase.database().ref('scores').orderByValue().once('value');\n```\n"},"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByValue","id":1123}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":725,"character":16}],"inheritedFrom":{"type":"reference","name":"Query.orderByValue","id":1123}},{"id":929,"name":"push","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":930,"name":"push","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new child location using a unique key and returns its `Reference`.","text":"This is the most common pattern for adding data to a collection of items.\n\nIf you provide a value to `push()`, the value will be written to the generated location.\nIf you don't pass a value, nothing will be written to the Database and the child will\nremain empty (but you can use the `Reference` elsewhere).\n\nThe unique key generated by push() are ordered by the current time, so the resulting list\nof items will be chronologically sorted. The keys are also designed to be unguessable\n(they contain 72 random bits of entropy).\n\n#### Example\n\n```js\nconst newUserRef = firebase.database().ref('users').push();\nconsole.log('New record key:', newUserRef.key);\nawait newUserRef.set({\n  first: 'Ada',\n  last: 'Lovelace',\n});\n```\n"},"parameters":[{"id":931,"name":"value","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional value to be written at the generated location."},"type":{"type":"intrinsic","name":"any"}},{"id":932,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"ThenableReference","id":988}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":391,"character":8}]},{"id":921,"name":"remove","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":922,"name":"remove","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes the data at this Database location.","text":"Any data at child locations will also be deleted.\n\nThe effect of the remove will be visible immediately and the corresponding event 'value' will be triggered.\nSynchronization of the remove to the Firebase servers will also be started, and the returned Promise will\nresolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization\nhas finished.\n\n#### Example\n\n```js\nawait firebase.database().ref('users/ada/name')\n .remove(() => {\n   console.log('Operation Complete');\n });\n```\n"},"parameters":[{"id":923,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":318,"character":10}]},{"id":901,"name":"set","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":902,"name":"set","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes data to this Database location.","text":"This will overwrite any data at this location and all child locations.\n\nThe effect of the write will be visible immediately, and the corresponding events\n(\"value\", \"child_added\", etc.) will be triggered. Synchronization of the data to the\nFirebase servers will also be started, and the returned Promise will resolve when\ncomplete. If provided, the `onComplete` callback will be called asynchronously after\nsynchronization has finished.\n\nPassing `null` for the new value is equivalent to calling `remove();` namely, all data at\nthis location and all child locations will be deleted.\n\n`set()` will remove any priority stored at this location, so if priority is meant to be\npreserved, you need to use `setWithPriority()` instead.\n\nNote that modifying data with set() will cancel any pending transactions at that location,\nso extreme care should be taken if mixing set() and transaction() to modify the same data.\n\nA single set() will generate a single \"value\" event at the location where the set() was performed.\n\n#### Example - Setting values\n\n```js\nconst ref = firebase.database().ref('users');\n\n// Set a single node value\nawait ref.child('ada/name/first').set('Ada');\nawait ref.child('ada/name/last').set('Lovelace');\n\n// Set an object value in a single call\nawait ref.child('ada/name').set({\n  first: 'Ada',\n  last: 'Lovelace',\n});\n```\n\n#### Example - On complete listener\n\n```js\nconst ref = firebase.database().ref('users');\n\nawait ref.child('ada/first/name').set('Ada', (error) => {\n  if (error) console.error(error);\n});\n```\n"},"parameters":[{"id":903,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to be written (string, number, boolean, object, array, or null)."},"type":{"type":"intrinsic","name":"any"}},{"id":904,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":212,"character":7}]},{"id":912,"name":"setPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":913,"name":"setPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a priority for the data at this Database location. Setting null removes any priority at this location.","text":"See {@link database.Query#orderByPriority} to learn how to use priority values in your query.\n\n#### Example\n\n```js\nawait firebase.database().ref('users/ada').setPriority(1, (error) => {\n  if (error) console.error(error);\n});\n```\n"},"parameters":[{"id":914,"name":"priority","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The priority value."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}},{"id":915,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":270,"character":15}]},{"id":916,"name":"setWithPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":917,"name":"setWithPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes data the Database location. Like `set()` but also specifies the priority for that data.","text":"#### Example\n\n```js\nawait firebase.database().ref('users/ada/name')\n .setWithPriority({\n   first: 'Ada',\n   last: 'Lovelace',\n }, 1, (error) => {\n   if (error) console.error(error);\n });\n```\n"},"parameters":[{"id":918,"name":"newVal","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new value to set."},"type":{"type":"intrinsic","name":"any"}},{"id":919,"name":"newPriority","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new priority to set."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}},{"id":920,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":291,"character":19}]},{"id":977,"name":"startAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":978,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a `Query` with the specified starting point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe starting point is inclusive, so children with exactly the specified value will be included\nin the query. The optional key argument can be used to further limit the range of the query.\nIf it is specified, then children that have exactly the specified value must also have a key\nname greater than or equal to the specified key.\n\nYou can read more about `startAt()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nawait firebase.database().ref('users').orderByChild('age').startAt(21).once('value');\n```\n"},"parameters":[{"id":979,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to start at. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":980,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to start at. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1125}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":749,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1125}},{"id":981,"name":"toJSON","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":982,"name":"toJSON","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a JSON-serializable representation of this object."},"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","name":"Query.toJSON","id":1129}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":754,"character":10}],"inheritedFrom":{"type":"reference","name":"Query.toJSON","id":1129}},{"id":983,"name":"toString","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":984,"name":"toString","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the absolute URL for this location.","text":"The `toString()` method returns a URL that is ready to be put into a browser, curl command, or\na `firebase.database().refFromURL()` call. Since all of those expect the URL to be url-encoded,\n`toString()` returns an encoded URL.\n\nAppend '.json' to the returned URL when typed into a browser to download JSON-formatted data.\nIf the location is secured (that is, not publicly readable), you will get a permission-denied error.\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref();\nconst ref2 = firebase.database().ref('users').orderByValue();\n\nref1.toString(); // https://sample-app.firebaseio.com/\nref2.toString(); // https://sample-app.firebaseio.com/users\n```\n"},"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"Query.toString","id":1131}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":776,"character":12}],"inheritedFrom":{"type":"reference","name":"Query.toString","id":1131}},{"id":924,"name":"transaction","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":925,"name":"transaction","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Atomically modifies the data at this location.","text":"Atomically modify the data at this location. Unlike a normal `set()`, which just overwrites\nthe data regardless of its previous value, `transaction()` is used to modify the existing\nvalue to a new value, ensuring there are no conflicts with other clients writing to the same\nlocation at the same time.\n\nTo accomplish this, you pass `transaction()` an update function which is used to transform the\ncurrent value into a new value. If another client writes to the location before your new\nvalue is successfully written, your update function will be called again with the new\ncurrent value, and the write will be retried. This will happen repeatedly until your write\nsucceeds without conflict or you abort the transaction by not returning a value from your\nupdate function.\n\nNote: Modifying data with `set()` will cancel any pending transactions at that location, so\nextreme care should be taken if mixing `set()` and `transaction()` to update the same data.\n\nNote: When using transactions with Security and Firebase Rules in place, be aware that a\nclient needs `.read` access in addition to `.write` access in order to perform a transaction.\nThis is because the client-side nature of transactions requires the client to read the data\nin order to transactionally update it.\n\n#### Example\n\n```js\nconst userRef = firebase.database().ref('users/ada/profileViews);\n\nuserRef.transaction((currentViews) => {\n  if (currentViews === null) return 1;\n  return currentViews + 1;\n});\n```\n"},"parameters":[{"id":926,"name":"transactionUpdate","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A developer-supplied function which will be passed the current data stored at this location (as a JavaScript object). The function should return the new value it would like written (as a JavaScript object). If undefined is returned (i.e. you return with no arguments) the transaction will be aborted and the data at this location will not be modified."},"type":{"type":"reference","name":"Function"}},{"id":927,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback function that will be called when the transaction completes. The callback is passed three arguments: a possibly-null Error, a boolean indicating whether the transaction was committed, and a DataSnapshot indicating the final result. If the transaction failed abnormally, the first argument will be an Error object indicating the failure cause. If the transaction finished normally, but no data was committed because no data was returned from transactionUpdate, then second argument will be false. If the transaction completed and committed data to Firebase, the second argument will be true. Regardless, the third argument will be a DataSnapshot containing the resulting data in this location."},"type":{"type":"reference","name":"Function"}},{"id":928,"name":"applyLocally","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"By default, events are raised each time the transaction update function runs. So if it is run multiple times, you may see intermediate states. You can set this to false to suppress these intermediate states and instead wait until the transaction has completed before events are raised.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"TransactionResult","id":891}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":358,"character":15}]},{"id":905,"name":"update","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":906,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes multiple values to the Database at once.","text":"The `values` argument contains multiple property-value pairs that will be written to the Database\ntogether. Each child property can either be a simple property (for example, \"name\") or a\nrelative path (for example, \"name/first\") from the current location to the data to update.\n\nAs opposed to the `set()` method, `update()` can be use to selectively update only the referenced\nproperties at the current location (instead of replacing all the child properties at the\ncurrent location).\n\nThe effect of the write will be visible immediately, and the corresponding events ('value',\n'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers\nwill also be started, and the returned Promise will resolve when complete. If provided, the\n`onComplete` callback will be called asynchronously after synchronization has finished.\n\nA single update() will generate a single \"value\" event at the location where the update()\nwas performed, regardless of how many children were modified.\n\nNote that modifying data with update() will cancel any pending transactions at that location,\nso extreme care should be taken if mixing update() and transaction() to modify the same data.\n\nPassing `null` to `update()` will remove the data at this location.\n\n#### Example\n\nModify the 'first' and 'last' properties, but leave other values unchanged at this location.\n\n```js\nawait firebase.database().ref('users/ada/name').update({\n  first: 'Ada',\n  last: 'Lovelace',\n})\n```\n"},"parameters":[{"id":907,"name":"values","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Object containing multiple values."},"type":{"type":"reflection","declaration":{"id":908,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":909,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":910,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":252,"character":18}]}}},{"id":911,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":252,"character":10}]}],"groups":[{"title":"Properties","kind":1024,"children":[900,895,935,896]},{"title":"Methods","kind":2048,"children":[897,936,940,944,985,947,950,953,958,933,964,968,971,973,975,929,921,901,912,916,977,981,983,924,905]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":112,"character":28}],"extendedTypes":[{"type":"reference","name":"Query","id":1082}],"extendedBy":[{"type":"reference","name":"ThenableReference","id":988}]},{"id":887,"name":"ServerValue","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The ServerValue interface provides access to Firebase server values."},"children":[{"id":888,"name":"TIMESTAMP","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A placeholder value for auto-populating the current timestamp (time since the Unix epoch,\nin milliseconds) as determined by the Firebase servers.","text":"#### Example\n\n```js\nfirebase.database().ref('sessions').push({\n  startedAt: firebase.database.ServerValue.TIMESTAMP,\n});\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":75,"character":13}],"type":{"type":"intrinsic","name":"object"}}],"groups":[{"title":"Properties","kind":1024,"children":[888]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":62,"character":30}]},{"id":889,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Realtime Database statics.","text":"#### Example\n\n```js\nfirebase.database;\n```\n"},"children":[{"id":890,"name":"ServerValue","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns server specific values, such as the server timestamp.","text":"#### Example\n\n```js\nfirebase.database.ServerValue;\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":97,"character":15}],"type":{"type":"reference","name":"ServerValue","id":887}}],"groups":[{"title":"Properties","kind":1024,"children":[890]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":87,"character":26}]},{"id":988,"name":"ThenableReference","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":994,"name":"key","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The last part of the Reference's path.\nFor example, \"ada\" is the key for https://<DATABASE_NAME>.firebaseio.com/users/ada.\nThe key of a root Reference is null."},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":159,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"Reference.key","id":900}},{"id":989,"name":"parent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The parent location of a Reference. The parent of a root Reference is `null`.","text":"#### Example\n\n```js\nfirebase.database().ref().parent; // null\nfirebase.database().ref('users/dave').parent; // 'users' reference\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":123,"character":10}],"type":{"type":"union","types":[{"type":"reference","name":"Reference","id":894},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"Reference.parent","id":895}},{"id":1029,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a Reference to the Query's location."},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":423,"character":7}],"type":{"type":"reference","name":"Reference","id":894},"inheritedFrom":{"type":"reference","name":"Query.ref","id":1083}},{"id":990,"name":"root","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The root Reference of the Database.","text":"#### Example\n\n```js\nfirebase.database().ref().root; // '/' reference path\nfirebase.database().ref('users/ada').root; // '/' reference\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":135,"character":8}],"type":{"type":"reference","name":"Reference","id":894},"inheritedFrom":{"type":"reference","name":"Reference.root","id":896}},{"id":991,"name":"child","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":992,"name":"child","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a Reference for the location at the specified relative path.","text":"The relative path can either be a simple child name (for example, \"ada\") or a deeper\nslash-separated path (for example, \"ada/name/first\").\n\n#### Example\n\n```js\nconst usersRef = firebase.database().ref('users');\nconst adaRef = usersRef.child('ada/name/first'); // childRef path is 'users/ada/name/first'\n```\n"},"parameters":[{"id":993,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A relative path from this location to the desired child location.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Reference","id":894},"inheritedFrom":{"type":"reference","name":"Reference.child","id":897}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":152,"character":9}],"inheritedFrom":{"type":"reference","name":"Reference.child","id":897}},{"id":1030,"name":"endAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1031,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Query with the specified ending point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe ending point is inclusive, so children with exactly the specified value will be included\nin the query. The optional key argument can be used to further limit the range of the query.\nIf it is specified, then children that have exactly the specified value must also have a key\nname less than or equal to the specified key.\n\nYou can read more about endAt() in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nconst snapshot = await ref.orderByKey().endAt('Ada Lovelace').once('value');\n```\n"},"parameters":[{"id":1032,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to end at. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":1033,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1084}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":448,"character":9}],"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1084}},{"id":1034,"name":"equalTo","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1035,"name":"equalTo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Query with the specified ending point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe optional key argument can be used to further limit the range of the query. If it is\nspecified, then children that have exactly the specified value must also have exactly the\nspecified key as their key name. This can be used to filter result sets with many matches for the same value.\n\nYou can read more about equalTo() in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nconst snapshot = await ref.orderByChild('age').equalTo(30).once('value');\n```\n"},"parameters":[{"id":1036,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to match for. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":1037,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.equalTo","id":1088}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":472,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.equalTo","id":1088}},{"id":1038,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1039,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns whether or not the current and provided queries represent the same location, have the same query parameters.","text":"Two Reference objects are equivalent if they represent the same location and are from the same instance of\n{@link app}.  Equivalent queries share the same sort order, limits, and starting and ending points.\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref('users').orderByKey().endAt('Ada Lovelace');\nconst ref2 = firebase.database().ref('users').orderByKey();\n\nconsole.log(ref1.isEqual(ref2)); // false\n```\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref('users').orderByKey().endAt('Ada Lovelace');\nconst ref2 = firebase.database().ref('users').endAt('Ada Lovelace').orderByKey();\n\nconsole.log(ref1.isEqual(ref2)); // true\n```\n"},"parameters":[{"id":1040,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The query to compare against.\n"},"type":{"type":"reference","name":"Query","id":1082}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","name":"Query.isEqual","id":1092}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":500,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.isEqual","id":1092}},{"id":1079,"name":"keepSynced","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1080,"name":"keepSynced","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"By calling `keepSynced(true)` on a location, the data for that location will automatically\nbe downloaded and kept in sync, even when no listeners are attached for that location.","text":"#### Example\n\n```js\nconst ref = firebase.database().ref('users');\nawait ref.keepSynced(true);\n```\n"},"parameters":[{"id":1081,"name":"bool","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Pass `true` to keep this location synchronized, pass `false` to stop synchronization.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Query.keepSynced","id":1133}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":791,"character":14}],"inheritedFrom":{"type":"reference","name":"Query.keepSynced","id":1133}},{"id":1041,"name":"limitToFirst","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1042,"name":"limitToFirst","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` limited to the first specific number of children.","text":"The `limitToFirst()` method is used to set a maximum number of children to be synced for a\ngiven callback. If we set a limit of 100, we will initially only receive up to 100 `child_added`\nevents. If we have fewer than 100 messages stored in our Database, a child_added event will\nfire for each message. However, if we have over 100 messages, we will only receive a `child_added`\nevent for the first 100 ordered messages. As items change, we will receive `child_removed` events\nfor each item that drops out of the active list so that the total number stays at 100.\n\nYou can read more about `limitToFirst()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst snapshot = firebase.database().ref('users').orderByKey().limitToFirst(2).once('value');\nconsole.log(snapshot.numChildren()); // 2\n```\n"},"parameters":[{"id":1043,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of nodes to include in this query.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.limitToFirst","id":1095}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":523,"character":16}],"inheritedFrom":{"type":"reference","name":"Query.limitToFirst","id":1095}},{"id":1044,"name":"limitToLast","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1045,"name":"limitToLast","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object limited to the last specific number of children.","text":"The `limitToLast()` method is used to set a maximum number of children to be synced for a given\ncallback. If we set a limit of 100, we will initially only receive up to 100 `child_added` events.\nIf we have fewer than 100 messages stored in our Database, a `child_added` event will fire for\neach message. However, if we have over 100 messages, we will only receive a `child_added` event\nfor the last 100 ordered messages. As items change, we will receive `child_removed` events for\neach item that drops out of the active list so that the total number stays at 100.\n\nYou can read more about `limitToLast()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nconst snapshot = firebase.database().ref('users').orderByKey().limitToLast(2).once('value');\nconsole.log(snapshot.numChildren()); // 2\n```\n"},"parameters":[{"id":1046,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of nodes to include in this query.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.limitToLast","id":1098}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":546,"character":15}],"inheritedFrom":{"type":"reference","name":"Query.limitToLast","id":1098}},{"id":1047,"name":"off","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1048,"name":"off","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detaches a callback previously attached with `on()`.","text":"Detach a callback previously attached with `on()`. Note that if `on()` was called multiple times\nwith the same eventType and callback, the callback will be called multiple times for each\nevent, and `off()` must be called multiple times to remove the callback. Calling `off()` on a parent\nlistener will not automatically remove listeners registered on child nodes, `off()` must also be\ncalled on any child listeners to remove the callback.\n\nIf a callback is not specified, all callbacks for the specified eventType will be removed.\nSimilarly, if no eventType is specified, all callbacks for the `Reference` will be removed.\n\n#### Example\n\n```js\nconst ref = firebase.database().ref('settings');\nconst onValueChange = function(snapshot) { ... };\nconst onChildAdded = function(snapshot) { ... };\n\nref.on('value', onValueChange);\nref.child('meta-data').on('child_added', onChildAdded);\n// Sometime later...\nref.off('value', onValueChange);\nref.child('meta-data').off('child_added', onChildAdded);\n```\n"},"parameters":[{"id":1049,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\" If omitted, all callbacks for the Reference will be removed."},"type":{"type":"reference","name":"EventType","id":1208}},{"id":1050,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The callback function that was passed to `on()` or `undefined` to remove all callbacks."},"type":{"type":"reference","name":"Function"}},{"id":1051,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The context that was passed to `on()`.\n"},"type":{"type":"reference","name":"Object"}}],"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","name":"Query.off","id":1101}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":578,"character":7}],"inheritedFrom":{"type":"reference","name":"Query.off","id":1101}},{"id":1052,"name":"on","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1053,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listens for data changes at a particular location.","text":"This is the primary way to read data from a Database. Your callback will be triggered for the\ninitial data and again whenever the data changes. Use `off()` to stop receiving updates..\n\n**value** event\n\nThis event will trigger once with the initial data stored at this location, and then trigger\nagain each time the data changes. The `DataSnapshot` passed to the callback will be for the location\nat which on() was called. It won't trigger until the entire contents has been synchronized.\nIf the location has no data, it will be triggered with an empty `DataSnapshot`\n(`val()` will return `null`).\n\n**child_added** event\n\nThis event will be triggered once for each initial child at this location, and it will be\ntriggered again every time a new child is added. The `DataSnapshot` passed into the callback\nwill reflect the data for the relevant child. For ordering purposes, it is passed a second argument\nwhich is a string containing the key of the previous sibling child by sort order, or `null` if\nit is the first child.\n\n**child_removed** event\n\nThis event will be triggered once every time a child is removed. The `DataSnapshot` passed into\nthe callback will be the old data for the child that was removed. A child will get removed when either:\n- a client explicitly calls `remove()` on that child or one of its ancestors\n- a client calls `set(null)` on that child or one of its ancestors\n- that child has all of its children removed\n- there is a query in effect which now filters out the child (because it's sort order changed or the max limit was hit)\n\n**child_changed** event\n\nThis event will be triggered when the data stored in a child (or any of its descendants) changes.\nNote that a single `child_changed` event may represent multiple changes to the child. The\n`DataSnapshot` passed to the callback will contain the new child contents. For ordering purposes,\nthe callback is also passed a second argument which is a string containing the key of the previous\nsibling child by sort order, or `null` if it is the first child.\n\n**child_moved** event\n\nThis event will be triggered when a child's sort order changes such that its position relative\nto its siblings changes. The `DataSnapshot` passed to the callback will be for the data of the child\nthat has moved. It is also passed a second argument which is a string containing the key of the\nprevious sibling child by sort order, or `null` if it is the first child.\n"},"parameters":[{"id":1054,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\""},"type":{"type":"reference","name":"EventType","id":1208}},{"id":1055,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback that fires when the specified event occurs. The callback will be passed a DataSnapshot. For ordering purposes, \"child_added\", \"child_changed\", and \"child_moved\" will also be passed a string containing the key of the previous child, by sort order, or `null` if it is the first child."},"type":{"type":"reference","name":"Function"}},{"id":1056,"name":"cancelCallbackOrContext","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional callback that will be notified if your event subscription is ever canceled because your client does not have permission to read this data (or it had permission but has now lost it). This callback will be passed an `Error` object indicating why the failure occurred."},"type":{"type":"reference","name":"Object"}},{"id":1057,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"If provided, this object will be used as `this` when calling your callback(s).\n\n"},"type":{"type":"union","types":[{"type":"reference","name":"Object"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Function"},"inheritedFrom":{"type":"reference","name":"Query.on","id":1106}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":632,"character":6}],"inheritedFrom":{"type":"reference","name":"Query.on","id":1106}},{"id":1027,"name":"onDisconnect","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1028,"name":"onDisconnect","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an {@link database.OnDisconnect} instance.","text":"#### Example\n\n```js\nconst userDisconnectRef = firebase.database().ref('users/ada/isOnline').onDisconnect();\n// When going offline\nawait userDisconnectRef.update(false);\n```\n"},"type":{"type":"reference","name":"OnDisconnect","id":1136},"inheritedFrom":{"type":"reference","name":"Reference.onDisconnect","id":933}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":404,"character":16}],"inheritedFrom":{"type":"reference","name":"Reference.onDisconnect","id":933}},{"id":1058,"name":"once","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1059,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listens for exactly one event of the specified event type, and then stops listening.","text":"This is equivalent to calling `on()`, and then calling `off()` inside the callback function. See `on()` for details on the event types.\n\n#### Example\n\n```js\n// Promise\nconst snapshot = await firebase.database().ref('users').once('value');\n// Callback\nfirebase.database().ref('users).once('value', (snapshot) => {\n  console.log(snapshot.val());\n});\n```\n"},"parameters":[{"id":1060,"name":"eventType","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"One of the following strings: \"value\", \"child_added\", \"child_changed\", \"child_removed\", or \"child_moved.\""},"type":{"type":"reference","name":"EventType","id":1208}},{"id":1061,"name":"successCallback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback that fires when the specified event occurs. The callback will be passed a DataSnapshot. For ordering purposes, \"child_added\", \"child_changed\", and \"child_moved\" will also be passed a string containing the key of the previous child by sort order, or `null` if it is the first child.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"DataSnapshot","id":1159}]},"inheritedFrom":{"type":"reference","name":"Query.once","id":1112}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":658,"character":8}],"inheritedFrom":{"type":"reference","name":"Query.once","id":1112}},{"id":1062,"name":"orderByChild","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1063,"name":"orderByChild","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by the specified child key.","text":"Queries can only order by one key at a time. Calling `orderByChild()` multiple times on the same query is an error.\n\nFirebase queries allow you to order your data by any child key on the fly. However, if you know in advance what\nyour indexes will be, you can define them via the [.indexOn](https://firebase.google.com/docs/database/security/indexing-data?authuser=0)\nrule in your Security Rules for better performance.\n\nYou can read more about orderByChild() in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').orderByChild('age').once('value');\nsnapshot.forEach((snapshot) => {\n console.log('Users age:', snapshot.val().age);\n});\n```\n"},"parameters":[{"id":1064,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The child path node to order by.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByChild","id":1116}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":682,"character":16}],"inheritedFrom":{"type":"reference","name":"Query.orderByChild","id":1116}},{"id":1065,"name":"orderByKey","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1066,"name":"orderByKey","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by key.","text":"Sorts the results of a query by their (ascending) key values.\n\nYou can read more about `orderByKey()` in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nconst snapshot = await firebase.database().ref('users').orderByKey().once('value');\nsnapshot.forEach((snapshot) => {\n console.log('User:', snapshot.val());\n});\n```\n"},"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByKey","id":1119}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":700,"character":14}],"inheritedFrom":{"type":"reference","name":"Query.orderByKey","id":1119}},{"id":1067,"name":"orderByPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1068,"name":"orderByPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new Query object ordered by priority.","text":"Applications need not use priority but can order collections by ordinary properties\n(see [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data)\nfor alternatives to priority).\n"},"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByPriority","id":1121}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":709,"character":19}],"inheritedFrom":{"type":"reference","name":"Query.orderByPriority","id":1121}},{"id":1069,"name":"orderByValue","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1070,"name":"orderByValue","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new `Query` object ordered by value.","text":"If the children of a query are all scalar values (string, number, or boolean), you can order\nthe results by their (ascending) values.\n\nYou can read more about `orderByValue()` in [Sort data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#sort_data).\n\n#### Example\n\n```js\nawait firebase.database().ref('scores').orderByValue().once('value');\n```\n"},"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.orderByValue","id":1123}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":725,"character":16}],"inheritedFrom":{"type":"reference","name":"Query.orderByValue","id":1123}},{"id":1023,"name":"push","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1024,"name":"push","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Generates a new child location using a unique key and returns its `Reference`.","text":"This is the most common pattern for adding data to a collection of items.\n\nIf you provide a value to `push()`, the value will be written to the generated location.\nIf you don't pass a value, nothing will be written to the Database and the child will\nremain empty (but you can use the `Reference` elsewhere).\n\nThe unique key generated by push() are ordered by the current time, so the resulting list\nof items will be chronologically sorted. The keys are also designed to be unguessable\n(they contain 72 random bits of entropy).\n\n#### Example\n\n```js\nconst newUserRef = firebase.database().ref('users').push();\nconsole.log('New record key:', newUserRef.key);\nawait newUserRef.set({\n  first: 'Ada',\n  last: 'Lovelace',\n});\n```\n"},"parameters":[{"id":1025,"name":"value","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional value to be written at the generated location."},"type":{"type":"intrinsic","name":"any"}},{"id":1026,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete.\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"ThenableReference","id":988},"inheritedFrom":{"type":"reference","name":"Reference.push","id":929}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":391,"character":8}],"inheritedFrom":{"type":"reference","name":"Reference.push","id":929}},{"id":1015,"name":"remove","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1016,"name":"remove","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes the data at this Database location.","text":"Any data at child locations will also be deleted.\n\nThe effect of the remove will be visible immediately and the corresponding event 'value' will be triggered.\nSynchronization of the remove to the Firebase servers will also be started, and the returned Promise will\nresolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization\nhas finished.\n\n#### Example\n\n```js\nawait firebase.database().ref('users/ada/name')\n .remove(() => {\n   console.log('Operation Complete');\n });\n```\n"},"parameters":[{"id":1017,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Reference.remove","id":921}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":318,"character":10}],"inheritedFrom":{"type":"reference","name":"Reference.remove","id":921}},{"id":995,"name":"set","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":996,"name":"set","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes data to this Database location.","text":"This will overwrite any data at this location and all child locations.\n\nThe effect of the write will be visible immediately, and the corresponding events\n(\"value\", \"child_added\", etc.) will be triggered. Synchronization of the data to the\nFirebase servers will also be started, and the returned Promise will resolve when\ncomplete. If provided, the `onComplete` callback will be called asynchronously after\nsynchronization has finished.\n\nPassing `null` for the new value is equivalent to calling `remove();` namely, all data at\nthis location and all child locations will be deleted.\n\n`set()` will remove any priority stored at this location, so if priority is meant to be\npreserved, you need to use `setWithPriority()` instead.\n\nNote that modifying data with set() will cancel any pending transactions at that location,\nso extreme care should be taken if mixing set() and transaction() to modify the same data.\n\nA single set() will generate a single \"value\" event at the location where the set() was performed.\n\n#### Example - Setting values\n\n```js\nconst ref = firebase.database().ref('users');\n\n// Set a single node value\nawait ref.child('ada/name/first').set('Ada');\nawait ref.child('ada/name/last').set('Lovelace');\n\n// Set an object value in a single call\nawait ref.child('ada/name').set({\n  first: 'Ada',\n  last: 'Lovelace',\n});\n```\n\n#### Example - On complete listener\n\n```js\nconst ref = firebase.database().ref('users');\n\nawait ref.child('ada/first/name').set('Ada', (error) => {\n  if (error) console.error(error);\n});\n```\n"},"parameters":[{"id":997,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to be written (string, number, boolean, object, array, or null)."},"type":{"type":"intrinsic","name":"any"}},{"id":998,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Reference.set","id":901}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":212,"character":7}],"inheritedFrom":{"type":"reference","name":"Reference.set","id":901}},{"id":1006,"name":"setPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1007,"name":"setPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a priority for the data at this Database location. Setting null removes any priority at this location.","text":"See {@link database.Query#orderByPriority} to learn how to use priority values in your query.\n\n#### Example\n\n```js\nawait firebase.database().ref('users/ada').setPriority(1, (error) => {\n  if (error) console.error(error);\n});\n```\n"},"parameters":[{"id":1008,"name":"priority","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The priority value."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}},{"id":1009,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Reference.setPriority","id":912}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":270,"character":15}],"inheritedFrom":{"type":"reference","name":"Reference.setPriority","id":912}},{"id":1010,"name":"setWithPriority","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1011,"name":"setWithPriority","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes data the Database location. Like `set()` but also specifies the priority for that data.","text":"#### Example\n\n```js\nawait firebase.database().ref('users/ada/name')\n .setWithPriority({\n   first: 'Ada',\n   last: 'Lovelace',\n }, 1, (error) => {\n   if (error) console.error(error);\n });\n```\n"},"parameters":[{"id":1012,"name":"newVal","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new value to set."},"type":{"type":"intrinsic","name":"any"}},{"id":1013,"name":"newPriority","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new priority to set."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}},{"id":1014,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Reference.setWithPriority","id":916}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":291,"character":19}],"inheritedFrom":{"type":"reference","name":"Reference.setWithPriority","id":916}},{"id":1071,"name":"startAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1072,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a `Query` with the specified starting point.","text":"Using `startAt()`, `endAt()`, and `equalTo()` allows you to choose arbitrary starting and\nending points for your queries.\n\nThe starting point is inclusive, so children with exactly the specified value will be included\nin the query. The optional key argument can be used to further limit the range of the query.\nIf it is specified, then children that have exactly the specified value must also have a key\nname greater than or equal to the specified key.\n\nYou can read more about `startAt()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data?authuser=0#filtering_data).\n\n#### Example\n\n```js\nawait firebase.database().ref('users').orderByChild('age').startAt(21).once('value');\n```\n"},"parameters":[{"id":1073,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to start at. The argument type depends on which `orderBy*()` function was used in this query. Specify a value that matches the `orderBy*()` type. When used in combination with `orderByKey()`, the value must be a string."},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"null"}]}},{"id":1074,"name":"key","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The child key to start at. This argument is only allowed if ordering by child, value, or priority.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Query","id":1082},"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1125}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":749,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1125}},{"id":1075,"name":"toJSON","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1076,"name":"toJSON","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a JSON-serializable representation of this object."},"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","name":"Query.toJSON","id":1129}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":754,"character":10}],"inheritedFrom":{"type":"reference","name":"Query.toJSON","id":1129}},{"id":1077,"name":"toString","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1078,"name":"toString","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the absolute URL for this location.","text":"The `toString()` method returns a URL that is ready to be put into a browser, curl command, or\na `firebase.database().refFromURL()` call. Since all of those expect the URL to be url-encoded,\n`toString()` returns an encoded URL.\n\nAppend '.json' to the returned URL when typed into a browser to download JSON-formatted data.\nIf the location is secured (that is, not publicly readable), you will get a permission-denied error.\n\n#### Example\n\n```js\nconst ref1 = firebase.database().ref();\nconst ref2 = firebase.database().ref('users').orderByValue();\n\nref1.toString(); // https://sample-app.firebaseio.com/\nref2.toString(); // https://sample-app.firebaseio.com/users\n```\n"},"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"Query.toString","id":1131}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":776,"character":12}],"inheritedFrom":{"type":"reference","name":"Query.toString","id":1131}},{"id":1018,"name":"transaction","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1019,"name":"transaction","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Atomically modifies the data at this location.","text":"Atomically modify the data at this location. Unlike a normal `set()`, which just overwrites\nthe data regardless of its previous value, `transaction()` is used to modify the existing\nvalue to a new value, ensuring there are no conflicts with other clients writing to the same\nlocation at the same time.\n\nTo accomplish this, you pass `transaction()` an update function which is used to transform the\ncurrent value into a new value. If another client writes to the location before your new\nvalue is successfully written, your update function will be called again with the new\ncurrent value, and the write will be retried. This will happen repeatedly until your write\nsucceeds without conflict or you abort the transaction by not returning a value from your\nupdate function.\n\nNote: Modifying data with `set()` will cancel any pending transactions at that location, so\nextreme care should be taken if mixing `set()` and `transaction()` to update the same data.\n\nNote: When using transactions with Security and Firebase Rules in place, be aware that a\nclient needs `.read` access in addition to `.write` access in order to perform a transaction.\nThis is because the client-side nature of transactions requires the client to read the data\nin order to transactionally update it.\n\n#### Example\n\n```js\nconst userRef = firebase.database().ref('users/ada/profileViews);\n\nuserRef.transaction((currentViews) => {\n  if (currentViews === null) return 1;\n  return currentViews + 1;\n});\n```\n"},"parameters":[{"id":1020,"name":"transactionUpdate","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A developer-supplied function which will be passed the current data stored at this location (as a JavaScript object). The function should return the new value it would like written (as a JavaScript object). If undefined is returned (i.e. you return with no arguments) the transaction will be aborted and the data at this location will not be modified."},"type":{"type":"reference","name":"Function"}},{"id":1021,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback function that will be called when the transaction completes. The callback is passed three arguments: a possibly-null Error, a boolean indicating whether the transaction was committed, and a DataSnapshot indicating the final result. If the transaction failed abnormally, the first argument will be an Error object indicating the failure cause. If the transaction finished normally, but no data was committed because no data was returned from transactionUpdate, then second argument will be false. If the transaction completed and committed data to Firebase, the second argument will be true. Regardless, the third argument will be a DataSnapshot containing the resulting data in this location."},"type":{"type":"reference","name":"Function"}},{"id":1022,"name":"applyLocally","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"By default, events are raised each time the transaction update function runs. So if it is run multiple times, you may see intermediate states. You can set this to false to suppress these intermediate states and instead wait until the transaction has completed before events are raised.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"TransactionResult","id":891}]},"inheritedFrom":{"type":"reference","name":"Reference.transaction","id":924}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":358,"character":15}],"inheritedFrom":{"type":"reference","name":"Reference.transaction","id":924}},{"id":999,"name":"update","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1000,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes multiple values to the Database at once.","text":"The `values` argument contains multiple property-value pairs that will be written to the Database\ntogether. Each child property can either be a simple property (for example, \"name\") or a\nrelative path (for example, \"name/first\") from the current location to the data to update.\n\nAs opposed to the `set()` method, `update()` can be use to selectively update only the referenced\nproperties at the current location (instead of replacing all the child properties at the\ncurrent location).\n\nThe effect of the write will be visible immediately, and the corresponding events ('value',\n'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers\nwill also be started, and the returned Promise will resolve when complete. If provided, the\n`onComplete` callback will be called asynchronously after synchronization has finished.\n\nA single update() will generate a single \"value\" event at the location where the update()\nwas performed, regardless of how many children were modified.\n\nNote that modifying data with update() will cancel any pending transactions at that location,\nso extreme care should be taken if mixing update() and transaction() to modify the same data.\n\nPassing `null` to `update()` will remove the data at this location.\n\n#### Example\n\nModify the 'first' and 'last' properties, but leave other values unchanged at this location.\n\n```js\nawait firebase.database().ref('users/ada/name').update({\n  first: 'Ada',\n  last: 'Lovelace',\n})\n```\n"},"parameters":[{"id":1001,"name":"values","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Object containing multiple values."},"type":{"type":"reflection","declaration":{"id":1002,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1003,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1004,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":252,"character":18}]}}},{"id":1005,"name":"onComplete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Callback called when write to server is complete. Contains the parameters (Error | null).\n"},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]},"inheritedFrom":{"type":"reference","name":"Reference.update","id":905}}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":252,"character":10}],"inheritedFrom":{"type":"reference","name":"Reference.update","id":905}}],"groups":[{"title":"Properties","kind":1024,"children":[994,989,1029,990]},{"title":"Methods","kind":2048,"children":[991,1030,1034,1038,1079,1041,1044,1047,1052,1027,1058,1062,1065,1067,1069,1023,1015,995,1006,1010,1071,1075,1077,1018,999]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":407,"character":36}],"extendedTypes":[{"type":"reference","name":"Reference","id":894}]},{"id":891,"name":"TransactionResult","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":892,"name":"committed","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":101,"character":13}],"type":{"type":"intrinsic","name":"boolean"}},{"id":893,"name":"snapshot","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":102,"character":12}],"type":{"type":"reference","name":"DataSnapshot","id":1159}}],"groups":[{"title":"Properties","kind":1024,"children":[892,893]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":100,"character":36}]},{"id":1208,"name":"EventType","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":900,"character":23}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"value"},{"type":"stringLiteral","value":"child_added"},{"type":"stringLiteral","value":"child_changed"},{"type":"stringLiteral","value":"child_moved"},{"type":"stringLiteral","value":"child_removed"}]}}],"groups":[{"title":"Classes","kind":128,"children":[1185]},{"title":"Interfaces","kind":256,"children":[1159,1136,1082,894,887,889,988,891]},{"title":"Type aliases","kind":4194304,"children":[1208]}],"sources":[{"fileName":"packages/database/lib/index.d.ts","line":56,"character":38}]},{"id":1218,"name":"FirebaseDynamicLinksTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Dynamic Links package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `dynamicLinks` package:\n\n```js\nimport { firebase } from '@react-native-firebase/dynamic-links';\n\n// firebase.dynamicLinks().X\n```\n\n#### Example 2\n\nUsing the default export from the `dynamic-links` package:\n\n```js\nimport dynamicLinks from '@react-native-firebase/dynamic-links';\n\n// dynamicLinks().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/dynamic-links';\n\n// firebase.dynamicLinks().X\n```\n","tags":[{"tag":"firebase","text":"dynamic-links\n"}]},"children":[{"id":1256,"name":"ShortLinkType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"ShortLinkType determines the type of dynamic short link which Firebase creates. Used when building\na new short link via `buildShortLink()`.","text":"#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildShortLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n }, FirebaseDynamicLinksTypes.ShortLinkType.UNGUESSABLE);\n```\n"},"children":[{"id":1259,"name":"DEFAULT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"By default, Firebase returns a standard formatted link."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":393,"character":11}],"defaultValue":"\"DEFAULT\""},{"id":1257,"name":"SHORT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Shorten the path to a string that is only as long as needed to be unique, with a minimum length\nof 4 characters. Use this if sensitive information would not be exposed if a short\nDynamic Link URL were guessed."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":383,"character":9}],"defaultValue":"\"SHORT\""},{"id":1258,"name":"UNGUESSABLE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Shorten the path to an unguessable string. Such strings are created by base62-encoding randomly\ngenerated 96-bit numbers, and consist of 17 alphanumeric characters. Use unguessable strings\nto prevent your Dynamic DynamicLinks from being crawled, which can potentially expose sensitive information."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":389,"character":15}],"defaultValue":"\"UNGUESSABLE\""}],"groups":[{"title":"Enumeration members","kind":16,"children":[1259,1257,1258]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":377,"character":27}]},{"id":1265,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Dynamic DynamicLinks service is available for the default app only.","text":"#### Example 1\n\nGet the links instance for the **default app**:\n\n```js\nconst links = firebase.dynamicLinks();\n```\n"},"children":[{"id":1285,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":1266,"name":"buildLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1267,"name":"buildLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Builds a Dynamic Link from the provided DynamicLinkParameters instances.","text":"#### Example\n\n```js\nconst link = await firebase.dynamicLinks().buildLink({\n  link: 'https://invertase.io',\n  domainUriPrefix: 'https://xyz.page.link',\n  analytics: {\n    campaign: 'banner',\n  }\n});\n```\n"},"parameters":[{"id":1268,"name":"dynamicLinkParams","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object interface of DynamicLinkParameters.\n"},"type":{"type":"reference","name":"DynamicLinkParameters","id":1247}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":466,"character":13}]},{"id":1272,"name":"buildShortLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1273,"name":"buildShortLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Builds a short Dynamic Link from the provided DynamicLinkParameters interface.","text":" ```js\nconst link = await firebase.dynamicLinks().buildShortLink(\n  {\n    link: 'https://invertase.io',\n    domainUriPrefix: 'https://xyz.page.link',\n    analytics: {\n      campaign: 'banner',\n    }\n  },\n  firebase.dynamicLinks.ShortLinkType.UNGUESSABLE,\n);\n```\n"},"parameters":[{"id":1274,"name":"dynamicLinkParams","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object interface of DynamicLinkParameters."},"type":{"type":"reference","name":"DynamicLinkParameters","id":1247}},{"id":1275,"name":"shortLinkType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The short link type, one of `ShortLinkType` from `firebase.dynamicLinks.ShortLinkType`\n"},"type":{"type":"reference","name":"ShortLinkType","id":1256}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":495,"character":18}]},{"id":1269,"name":"createDynamicLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1270,"name":"createDynamicLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"**Deprecated**: Creates a link from the provided DynamicLinkParameters interface.","tags":[{"tag":"deprecated","text":"Use `buildLink` with the same args instead."}]},"parameters":[{"id":1271,"name":"dynamicLinkParams","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object interface of DynamicLinkParameters.\n"},"type":{"type":"reference","name":"DynamicLinkParameters","id":1247}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":474,"character":21}]},{"id":1276,"name":"createShortDynamicLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1277,"name":"createShortDynamicLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"**Deprecated**: Creates a short Dynamic Link from the provided DynamicLinkParameters instances.","tags":[{"tag":"deprecated","text":"Use `buildShortLink` with the same args instead."}]},"parameters":[{"id":1278,"name":"dynamicLinkParams","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object interface of DynamicLinkParameters."},"type":{"type":"reference","name":"DynamicLinkParameters","id":1247}},{"id":1279,"name":"shortLinkType","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The short link type, one of `ShortLinkType` from `firebase.dynamicLinks.ShortLinkType`\n"},"type":{"type":"reference","name":"ShortLinkType","id":1256}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":507,"character":26}]},{"id":1280,"name":"getInitialLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1281,"name":"getInitialLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the Dynamic Link that the app has been launched from. If the app was not launched from a Dynamic Link the value will be null.","text":"> Use {@link auth#isSignInWithEmailLink} to check if an inbound dynamic link is an email sign-in link.\n\n#### Example\n\n```js\nasync function bootstrapApp() {\n   const initialLink = await firebase.dynamicLinks().getInitialLink();\n\n   if (initialLink) {\n     // Handle dynamic link inside your own application\n     if (initialLink.url === 'https://invertase.io/offer') return navigateTo('/offers')\n   }\n}\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"union","types":[{"type":"reference","name":"DynamicLink","id":1260},{"type":"intrinsic","name":"null"}]}]}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":530,"character":18}]},{"id":1282,"name":"onLink","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1283,"name":"onLink","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Subscribe to Dynamic Link open events while the app is still running.","text":"The listener is called from Dynamic Link open events whilst the app is still running, use\n{@link dynamic-links#getInitialLink} for Dynamic Links which cause the app to open from a previously closed / not running state.\n\n#### Example\n\n```jsx\nfunction App() {\n  const handleDynamicLink = (link) => {\n    // Handle dynamic link inside your own application\n    if (link.url === 'https://invertase.io/offer') return navigateTo('/offers')\n  };\n\n  useEffect(() => {\n    const unsubscribe = firebase.dynamicLinks().onLink(handleDynamicLink);\n    // When the component unmounts, remove the listener\n    return unsubscribe;\n  }, []);\n\n  return <YourApp />;\n}\n```\n","returns":"Unsubscribe function, call the returned function to unsubscribe from all future events."},"parameters":[{"id":1284,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The listener callback, called with Dynamic Link instances.\n"},"type":{"type":"reference","name":"Function","typeArguments":[{"type":"reference","name":"DynamicLink","id":1260}]}}],"type":{"type":"reference","name":"Function"}}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":560,"character":10}]}],"groups":[{"title":"Properties","kind":1024,"children":[1285]},{"title":"Methods","kind":2048,"children":[1266,1272,1269,1276,1280,1282]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":448,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":1260,"name":"DynamicLink","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A received Dynamic Link from either `onLink` or `getInitialLink`."},"children":[{"id":1262,"name":"minimumAppVersion","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The minimum app version requested to process the dynamic link.","text":"Returns `null` if not specified.\n\n#### Android\n\nOn Android this returns a number value representing the apps [versionCode](https://developer.android.com/reference/android/content/pm/PackageInfo.html#versionCode).\n\n#### iOS\n\nOn iOS this returns a string value representing the minimum app version (not the iOS system version). If the app version of the opening app is less than the value of this property, then the app is expected to open AppStore to allow user to download most recent version. App can notify or ask the user before opening AppStore.\n\n"},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":419,"character":21}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":1261,"name":"url","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The url of the dynamic link."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":403,"character":7}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[1262,1261]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":399,"character":30}]},{"id":1219,"name":"DynamicLinkAnalyticsParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkAnalyticsParameters interface provides functionality to add Google Analytic\nbased parameters to a dynamic link.","text":"#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n   analytics: {\n     campaign: 'banner',\n     content: 'Click Me',\n   }\n });\n```\n"},"children":[{"id":1220,"name":"campaign","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The individual campaign name, slogan, promo code, etc. for a product."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":80,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1221,"name":"content","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The campaign content; used for A/B testing and content-targeted ads to differentiate ads or links that point to the same URL."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":85,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1222,"name":"medium","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The campaign medium; used to identify a medium such as email or cost-per-click (cpc)."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":90,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1223,"name":"source","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The campaign source; used to identify a search engine, newsletter, or other source."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":95,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1224,"name":"term","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The campaign term; used with paid search to supply the keywords for ads."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":100,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1220,1221,1222,1223,1224]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":76,"character":49}]},{"id":1225,"name":"DynamicLinkAndroidParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkAndroidParameters interface provides functionality to configure the behaviour\nof dynamic links for Android devices.","text":"If any parameter is declared then the Android package name must also be set via `setPackageName`\n\n#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n   android: {\n     packageName: 'io.invertase.testing',\n     minimumVersion: '18',\n   }\n });\n```\n"},"children":[{"id":1226,"name":"fallbackUrl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the link to open when the app isn't installed. Specify this to do something other than install your app from\nthe Play Store when the app isn't installed, such as open the mobile web version of the content, or display a\npromotional page for your app."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":128,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1227,"name":"minimumVersion","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the version code of the minimum version of your app that can open the link."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":133,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1228,"name":"packageName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The package name of the Android app to use to open the link. The app must be connected to your project from the Overview page of the Firebase console.","text":"This option is required if passing android options to your dynamic link.\n"},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":140,"character":15}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[1226,1227,1228]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":122,"character":47}]},{"id":1229,"name":"DynamicLinkIOSParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkIOSParameters interface provides functionality to configure the behaviour\nof dynamic links for iOS devices.","text":"If any parameter is declared then the iOS BundleId must also be set via `setBundleId`\n\n#### Example\n\n```js\nconst linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link');\nlinkParams\n  .ios.setBundleId('io.invertase.testing')\n  .ios.setAppStoreId('123456789')\n  .ios.setMinimumVersion('18');\n\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n   ios: {\n     bundleId: 'io.invertase.testing',\n     appStoreId: '123456789',\n     minimumVersion: '18',\n   }\n });\n```\n"},"children":[{"id":1230,"name":"appStoreId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the App Store ID, used to send users to the App Store when the app isn't installed."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":173,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1231,"name":"bundleId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The bundle ID of the iOS app to use to open the link. The app must be connected to your project from the Overview page of the Firebase console.","text":"This option is required if passing ios options to your dynamic link.\n"},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":180,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":1232,"name":"customScheme","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the app's custom URL scheme, if defined to be something other than your app's parameters ID."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":185,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1233,"name":"fallbackUrl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the link to open when the app isn't installed. Specify this to do something other than install your app from\nthe App Store when the app isn't installed, such as open the mobile web version of the content, or display a\npromotional page for your app."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":192,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1234,"name":"iPadBundleId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the bundle ID of the iOS app to use on iPads to open the link. The app must be connected to your project\nfrom the Overview page of the Firebase console."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":198,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1235,"name":"iPadFallbackUrl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the link to open on iPads when the app isn't installed. Specify this to do something other than install your\napp from the App Store when the app isn't installed, such as open the web version of the content, or display a\npromotional page for your app. Overrides the fallback link set by `setFallbackUrl` on iPad."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":205,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1236,"name":"minimumVersion","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the minimum version of your app that can open the link."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":210,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1230,1231,1232,1233,1234,1235,1236]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":169,"character":43}]},{"id":1237,"name":"DynamicLinkITunesParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkITunesParameters interface provides functionality to add iTunes Connect Analytics\nbased parameters to the created dynamic link.","text":"#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n   itunes: {\n     affiliateToken: 'ABCDEFG',\n   }\n });\n```\n"},"children":[{"id":1238,"name":"affiliateToken","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The affiliate token used to create affiliate-coded links."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":233,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1239,"name":"campaignToken","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The campaign token that developers can add to any link in order to track sales from a specific marketing campaign."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":238,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1240,"name":"providerToken","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The provider token that enables analytics for Dynamic DynamicLinks from within iTunes Connect."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":243,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1238,1239,1240]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":229,"character":46}]},{"id":1241,"name":"DynamicLinkNavigationParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkNavigationParameters interface provides functionality to specify how the navigation\nof the created link is handled.","text":"#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n   navigation: {\n     forcedRedirectEnabled: true,\n   }\n });\n```\n"},"children":[{"id":1242,"name":"forcedRedirectEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets whether to enable force redirecting or going to the app preview page. Defaults to false.","text":"If true, app preview page will be disabled and there will be a redirect to the FDL. If false, go to the app preview page.\n"},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":268,"character":25}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1242]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":262,"character":50}]},{"id":1247,"name":"DynamicLinkParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkParameters interface provides access to the Dynamic Link builder classes\nused to configure a created link.","text":"#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n });\n```\n"},"children":[{"id":1250,"name":"analytics","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Access Google Analytics specific link parameters."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":336,"character":13}],"type":{"type":"reference","name":"DynamicLinkAnalyticsParameters","id":1219}},{"id":1251,"name":"android","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Access Android specific link parameters."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":341,"character":11}],"type":{"type":"reference","name":"DynamicLinkAndroidParameters","id":1225}},{"id":1249,"name":"domainUriPrefix","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Domain URI Prefix of your App. This value must be your assigned domain from the Firebase console,\n(e.g. https://xyz.page.link). The domain URI prefix must start with a valid HTTPS scheme (https://)."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":331,"character":19}],"type":{"type":"intrinsic","name":"string"}},{"id":1252,"name":"ios","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Access iOS specific link parameters."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":346,"character":7}],"type":{"type":"reference","name":"DynamicLinkIOSParameters","id":1229}},{"id":1253,"name":"itunes","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Access iTunes Connect specific link parameters."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":351,"character":10}],"type":{"type":"reference","name":"DynamicLinkITunesParameters","id":1237}},{"id":1248,"name":"link","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The link the target app will open. You can specify any URL the app can handle, such as a link to the app’s content,\nor a URL that initiates some app-specific logic such as crediting the user with a coupon, or displaying a\nspecific welcome screen. This link must be a well-formatted URL, be properly URL-encoded, and use the HTTP or\nHTTPS scheme."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":325,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":1254,"name":"navigation","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Access navigation specific link parameters."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":356,"character":14}],"type":{"type":"reference","name":"DynamicLinkNavigationParameters","id":1241}},{"id":1255,"name":"social","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Access social specific link parameters."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":361,"character":10}],"type":{"type":"reference","name":"DynamicLinkSocialParameters","id":1243}}],"groups":[{"title":"Properties","kind":1024,"children":[1250,1251,1249,1252,1253,1248,1254,1255]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":318,"character":40}]},{"id":1243,"name":"DynamicLinkSocialParameters","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The DynamicLinkSocialParameters interface provides functionality to add additional social\nmeta-data to the URL.","text":"#### Example\n\n```js\n const link = await firebase.dynamicLinks().buildLink({\n   link: 'https://invertase.io',\n   domainUriPrefix: 'https://xyz.page.link',\n   social: {\n     title: 'Social Application',\n     descriptionText: 'A Social Application',\n   }\n });\n```\n"},"children":[{"id":1244,"name":"descriptionText","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The description to use when the Dynamic Link is shared in a social post."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":292,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1245,"name":"imageUrl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The URL to an image related to this link."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":297,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1246,"name":"title","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The title to use when the Dynamic Link is shared in a social post."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":302,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1244,1245,1246]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":288,"character":46}]},{"id":1263,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Firebase Dynamic DynamicLinks Statics","text":"```js\nfirebase.dynamicLinks.X\n```\n"},"children":[{"id":1264,"name":"ShortLinkType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the {@link links.ShortLinkType} enum."},"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":433,"character":17}],"type":{"type":"reference","name":"ShortLinkType","id":1256}}],"groups":[{"title":"Properties","kind":1024,"children":[1264]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":429,"character":26}]}],"groups":[{"title":"Enumerations","kind":4,"children":[1256]},{"title":"Classes","kind":128,"children":[1265]},{"title":"Interfaces","kind":256,"children":[1260,1219,1225,1229,1237,1241,1247,1243,1263]}],"sources":[{"fileName":"packages/dynamic-links/lib/index.d.ts","line":56,"character":42}]},{"id":1293,"name":"FirebaseFirestoreTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Cloud Firestore package for React Native.","text":"#### Example: Access the firebase export from the `firestore` package:\n\n```js\nimport { firebase } from '@react-native-firebase/firestore';\n\n// firebase.firestore().X\n```\n\n#### Example: Using the default export from the `firestore` package:\n\n```js\nimport firestore from '@react-native-firebase/firestore';\n\n// firestore().X\n```\n\n#### Example: Using the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/firestore';\n\n// firebase.firestore().X\n```\n","tags":[{"tag":"firebase","text":"firestore\n"}]},"children":[{"id":1294,"name":"Blob","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"An immutable object representing an array of bytes."},"children":[{"id":1301,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1302,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `Blob` is equal to the provided one."},"parameters":[{"id":1303,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `Blob` to compare against.\n"},"type":{"type":"reference","name":"Blob","id":1294}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":76,"character":11}]},{"id":1304,"name":"toBase64","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1305,"name":"toBase64","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the bytes of a Blob as a Base64-encoded string."},"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":81,"character":12}]},{"id":1306,"name":"toUint8Array","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1307,"name":"toUint8Array","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the bytes of a Blob in a new Uint8Array."},"type":{"type":"reference","name":"Uint8Array"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":86,"character":16}]},{"id":1295,"name":"fromBase64String","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1296,"name":"fromBase64String","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new Blob from the given Base64 string, converting it to bytes."},"parameters":[{"id":1297,"name":"base64","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The Base64 string used to create the Blob object.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Blob","id":1294}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":62,"character":27}]},{"id":1298,"name":"fromUint8Array","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1299,"name":"fromUint8Array","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new Blob from the given Uint8Array."},"parameters":[{"id":1300,"name":"array","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The Uint8Array used to create the Blob object.\n"},"type":{"type":"reference","name":"Uint8Array"}}],"type":{"type":"reference","name":"Blob","id":1294}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":69,"character":25}]}],"groups":[{"title":"Methods","kind":2048,"children":[1301,1304,1306,1295,1298]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":56,"character":19}]},{"id":1557,"name":"FieldPath","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A FieldPath refers to a field in a document. The path may consist of a single field name (referring to a\ntop-level field in the document), or a list of field names (referring to a nested field in the document).","text":"Create a FieldPath by providing field names. If more than one field name is provided, the path will point to a nested field in a document.\n\n#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Create a new field path\nconst fieldPath = new firebase.firestore.FieldPath('address', 'zip');\n\nconsole.log('Address ZIP Code', user.get(fieldPath));\n```\n"},"children":[{"id":1560,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates a FieldPath from the provided field names. If more than one field name is provided, the path will point to a nested field in a document.","text":"#### Example\n\n```js\nconst fieldPath = new firebase.firestore.FieldPath('address', line', 'one');\n```\n"},"signatures":[{"id":1561,"name":"new FieldPath","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates a FieldPath from the provided field names. If more than one field name is provided, the path will point to a nested field in a document.","text":"#### Example\n\n```js\nconst fieldPath = new firebase.firestore.FieldPath('address', line', 'one');\n```\n"},"parameters":[{"id":1562,"name":"fieldNames","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"shortText":"A list of field names.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","name":"FieldPath","id":1557}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":590,"character":35}]},{"id":1563,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1564,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `FieldPath` is equal to the provided one.","text":"#### Example\n\n```js\nconst fieldPath1 = new firebase.firestore.FieldPath('address', 'zip');\nconst fieldPath2 = new firebase.firestore.FieldPath('address', line', 'one');\n\n// false\nfieldPath1.isEqual(fieldPath2);\n```\n"},"parameters":[{"id":1565,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `FieldPath` to compare against.\n"},"type":{"type":"reference","name":"FieldPath","id":1557}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":620,"character":11}]},{"id":1558,"name":"documentId","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1559,"name":"documentId","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a special sentinel `FieldPath` to refer to the ID of a document. It can be used in queries to sort or filter by the document ID."},"type":{"type":"reference","name":"FieldPath","id":1557}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":590,"character":21}]}],"groups":[{"title":"Constructors","kind":512,"children":[1560]},{"title":"Methods","kind":2048,"children":[1563,1558]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":586,"character":24}]},{"id":1566,"name":"FieldValue","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Sentinel values that can be used when writing document fields with `set()` or `update()`.","text":"#### Example\n\n```js\nconst increment = firebase.firestore.FieldValue.increment(1);\n\nawait firebase.firestore().doc('users/alovelace).update({\n  age: increment, // increment age by 1\n});\n```\n"},"children":[{"id":1580,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1581,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `FieldValue` is equal to the provided one.","text":"#### Example\n\n```js\nconst increment = firebase.firestore.FieldValue.increment(1);\nconst timestamp = firebase.firestore.FieldValue.serverTimestamp();\n\n// false\nincrement.isEqual(timestamp);\n```\n"},"parameters":[{"id":1582,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `FieldValue` to compare against.\n"},"type":{"type":"reference","name":"FieldValue","id":1566}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":750,"character":11}]},{"id":1567,"name":"arrayRemove","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1568,"name":"arrayRemove","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a special value that can be used with `set()` or `update()` that tells the server to remove the given elements\nfrom any array value that already exists on the server. All instances of each element specified will be removed from\nthe array. If the field being modified is not already an array it will be overwritten with an empty array.","text":"#### Example\n\n```js\nconst arrayRemove = firebase.firestore.FieldValue.arrayRemove(2, '3');\n\n// Removes the values 2 & '3' from the values array on the document\nawait docRef.update({\n  values: arrayRemove,\n});\n```\n"},"parameters":[{"id":1569,"name":"elements","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The elements to remove from the array.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"FieldValue","id":1566}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":655,"character":22}]},{"id":1570,"name":"arrayUnion","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1571,"name":"arrayUnion","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a special value that can be used with `set()` or `update()` that tells the server to union the given\nelements with any array value that already exists on the server. Each specified element that doesn't already exist\nin the array will be added to the end. If the field being modified is not already an array it will be overwritten\nwith an array containing exactly the specified elements.","text":"#### Example\n\n```js\nconst arrayUnion = firebase.firestore.FieldValue.arrayUnion(2, '3');\n\n// Appends the values 2 & '3' onto the values array on the document\nawait docRef.update({\n  values: arrayUnion,\n});\n```\n"},"parameters":[{"id":1572,"name":"elements","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The elements to union into the array.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"FieldValue","id":1566}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":676,"character":21}]},{"id":1573,"name":"delete","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1574,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a sentinel for use with update() to mark a field for deletion.","text":"#### Example\n\n```js\nconst delete = firebase.firestore.FieldValue.delete();\n\n// Deletes the name field on the document\nawait docRef.update({\n  name: delete,\n});\n```\n"},"type":{"type":"reference","name":"FieldValue","id":1566}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":692,"character":17}]},{"id":1575,"name":"increment","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1576,"name":"increment","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a special value that can be used with `set()` or `update()` that tells the server to increment the field's current value by the given value.","text":"If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics.\nIf both values are integers, values outside of JavaScript's safe number range (`Number.MIN_SAFE_INTEGER` to `Number.MAX_SAFE_INTEGER`)\nare also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are\ncapped between -2^63 and 2^63-1.\n\nIf the current field value is not of type `number`, or if the field does not yet exist, the transformation sets the field to the given value.\n\n#### Example\n\n```js\nconst increment = firebase.firestore.FieldValue.increment(1);\n\n// Increment the loginCount field by 1 on the document\nawait docRef.update({\n  loginCount: increment,\n});\n```\n"},"parameters":[{"id":1577,"name":"n","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value to increment by.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"FieldValue","id":1566}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":717,"character":20}]},{"id":1578,"name":"serverTimestamp","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1579,"name":"serverTimestamp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a sentinel used with set() or update() to include a server-generated timestamp in the written data.","text":"#### Example\n\n```js\nconst timestamp = firebase.firestore.FieldValue.serverTimestamp();\n\n// Set the updatedAt field to the current server time\nawait docRef.update({\n  updatedAt: timestamp,\n});\n```\n"},"type":{"type":"reference","name":"FieldValue","id":1566}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":733,"character":26}]}],"groups":[{"title":"Methods","kind":2048,"children":[1580,1567,1570,1573,1575,1578]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":636,"character":25}]},{"id":1583,"name":"GeoPoint","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"An immutable object representing a geo point in Firestore. The geo point is represented as latitude/longitude pair.","text":"Latitude values are in the range of [-90, 90]. Longitude values are in the range of [-180, 180].\n"},"children":[{"id":1584,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates a new immutable GeoPoint object with the provided latitude and longitude values.","text":"#### Example\n\n```js\nconst geoPoint = new firebase.firestore.GeoPoint(60, -40);\n```\n"},"signatures":[{"id":1585,"name":"new GeoPoint","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates a new immutable GeoPoint object with the provided latitude and longitude values.","text":"#### Example\n\n```js\nconst geoPoint = new firebase.firestore.GeoPoint(60, -40);\n```\n"},"parameters":[{"id":1586,"name":"latitude","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The latitude as number between -90 and 90."},"type":{"type":"intrinsic","name":"number"}},{"id":1587,"name":"longitude","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The longitude as number between -180 and 180.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"GeoPoint","id":1583}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":758,"character":25}]},{"id":1588,"name":"latitude","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The latitude of this `GeoPoint` instance."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":776,"character":12}],"type":{"type":"intrinsic","name":"number"}},{"id":1589,"name":"longitude","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The longitude of this `GeoPoint` instance."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":781,"character":13}],"type":{"type":"intrinsic","name":"number"}},{"id":1590,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1591,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `GeoPoint` is equal to the provided one.","text":"#### Example\n\n```js\nconst geoPoint1 = new firebase.firestore.GeoPoint(60, -40);\nconst geoPoint2 = new firebase.firestore.GeoPoint(60, -20);\n\n// false\ngeoPoint1.isEqual(geoPoint2);\n```\n"},"parameters":[{"id":1592,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `GeoPoint` to compare against.\n"},"type":{"type":"reference","name":"GeoPoint","id":1583}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":798,"character":11}]}],"groups":[{"title":"Constructors","kind":512,"children":[1584]},{"title":"Properties","kind":1024,"children":[1588,1589]},{"title":"Methods","kind":2048,"children":[1590]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":758,"character":23}]},{"id":1818,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Cloud Firestore service is available for the default app or a given app.","text":"#### Example: Get the firestore instance for the **default app**:\n\n```js\nconst firestoreForDefaultApp = firebase.firestore();\n```\n\n#### Example: Get the firestore instance for a **secondary app**:\n\n```js\nconst otherApp = firebase.app('otherApp');\nconst firestoreForOtherApp = firebase.firestore(otherApp);\n```\n\n"},"children":[{"id":1843,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":1819,"name":"batch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1820,"name":"batch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a write batch, used for performing multiple writes as a single atomic operation.\nThe maximum number of writes allowed in a single WriteBatch is 500, but note that each usage\nof `FieldValue.serverTimestamp()`, `FieldValue.arrayUnion()`, `FieldValue.arrayRemove()`, or `FieldValue.increment()`\ninside a WriteBatch counts as an additional write.","text":"#### Example\n\n```js\nconst batch = firebase.firestore().batch();\nbatch.delete(...);\n```\n"},"type":{"type":"reference","name":"WriteBatch","id":1782}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1833,"character":9}]},{"id":1821,"name":"collection","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1822,"name":"collection","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a `CollectionReference` instance that refers to the collection at the specified path.","text":"#### Example\n\n```js\nconst collectionReference = firebase.firestore().collection('users');\n```\n"},"parameters":[{"id":1823,"name":"collectionPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A slash-separated path to a collection.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"CollectionReference","id":1308}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1846,"character":14}]},{"id":1824,"name":"collectionGroup","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1825,"name":"collectionGroup","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that includes all documents in the database that are contained\nin a collection or subcollection with the given collectionId.","text":"#### Example\n\n```js\nconst collectionGroup = firebase.firestore().collectionGroup('orders');\n```\n"},"parameters":[{"id":1826,"name":"collectionId","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Identifies the collections to query over. Every collection or subcollection with this ID as the last segment of its path will be included. Cannot contain a slash.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1860,"character":19}]},{"id":1827,"name":"disableNetwork","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1828,"name":"disableNetwork","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Disables network usage for this instance. It can be re-enabled via `enableNetwork()`. While the\nnetwork is disabled, any snapshot listeners or get() calls will return results from cache, and any\nwrite operations will be queued until the network is restored.","text":"Returns a promise that is resolved once the network has been disabled.\n\n#### Example\n\n```js\nawait firebase.firestore().disableNetwork();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1875,"character":18}]},{"id":1829,"name":"doc","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1830,"name":"doc","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a `DocumentReference` instance that refers to the document at the specified path.","text":"#### Example\n\n```js\nconst documentReference = firebase.firestore().doc('users/alovelace');\n```\n"},"parameters":[{"id":1831,"name":"documentPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A slash-separated path to a document.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"DocumentReference","id":1427}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1888,"character":7}]},{"id":1832,"name":"enableNetwork","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1833,"name":"enableNetwork","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Re-enables use of the network for this Firestore instance after a prior call to `disableNetwork()`.","text":"#### Example\n\n```js\nawait firebase.firestore().enableNetwork();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1899,"character":17}]},{"id":1834,"name":"runTransaction","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1835,"name":"runTransaction","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Executes the given `updateFunction` and then attempts to commit the changes applied within the transaction.\nIf any document read within the transaction has changed, Cloud Firestore retries the `updateFunction`.\nIf it fails to commit after 5 attempts, the transaction fails.","text":"The maximum number of writes allowed in a single transaction is 500, but note that each usage of\n`FieldValue.serverTimestamp()`, `FieldValue.arrayUnion()`, `FieldValue.arrayRemove()`, or `FieldValue.increment()`\ninside a transaction counts as an additional write.\n\n#### Example\n\n```js\nconst cityRef = firebase.firestore().doc('cities/SF');\n\nawait firebase.firestore()\n  .runTransaction(async (transaction) => {\n    const snapshot = await transaction.get(cityRef);\n    await transaction.update(cityRef, {\n      population: snapshot.data().population + 1,\n    });\n  });\n```\n"},"parameters":[{"id":1836,"name":"updateFunction","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":1837,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1838,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1839,"name":"transaction","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Transaction","id":1755}}],"type":{"type":"reference","name":"Promise"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1924,"character":34}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"any"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1924,"character":18}]},{"id":1840,"name":"settings","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1841,"name":"settings","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Specifies custom settings to be used to configure the Firestore instance. Must be set before invoking any other methods.","text":"#### Example\n\n```js\nconst settings = {\n  cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED,\n};\n\nawait firebase.firestore().settings(settings);\n```\n"},"parameters":[{"id":1842,"name":"settings","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A `Settings` object.\n"},"type":{"type":"reference","name":"Settings","id":1720}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1941,"character":12}]}],"groups":[{"title":"Properties","kind":1024,"children":[1843]},{"title":"Methods","kind":2048,"children":[1819,1821,1824,1827,1829,1832,1834,1840]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1819,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":1733,"name":"Timestamp","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and\nfractions of seconds at nanosecond resolution in UTC Epoch time.","text":"It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one.\nIt is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are \"smeared\" so that no leap second table\nis needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.\n"},"children":[{"id":1742,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates a new timestamp."},"signatures":[{"id":1743,"name":"new Timestamp","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates a new timestamp."},"parameters":[{"id":1744,"name":"seconds","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The number of seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive."},"type":{"type":"intrinsic","name":"number"}},{"id":1745,"name":"nanoseconds","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanoseconds values that count forward in time. Must be from 0 to 999,999,999 inclusive.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Timestamp","id":1733}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1449,"character":28}]},{"id":1746,"name":"nanoseconds","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The number of nanoseconds of this `Timestamp`;"},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1462,"character":15}],"type":{"type":"intrinsic","name":"number"}},{"id":1747,"name":"seconds","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The number of seconds of this `Timestamp`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1467,"character":11}],"type":{"type":"intrinsic","name":"number"}},{"id":1748,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1749,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `Timestamp` is equal to the provided one."},"parameters":[{"id":1750,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `Timestamp` to compare against.\n"},"type":{"type":"reference","name":"Timestamp","id":1733}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1474,"character":11}]},{"id":1751,"name":"toDate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1752,"name":"toDate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Convert a Timestamp to a JavaScript Date object. This conversion causes a loss of precision since Date objects\nonly support millisecond precision.","text":"Returns a JavaScript [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) with\nmillseconds precision.\n"},"type":{"type":"reference","name":"Date"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1483,"character":10}]},{"id":1753,"name":"toMillis","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1754,"name":"toMillis","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Convert a timestamp to a numeric timestamp (in milliseconds since epoch). This operation causes a loss of precision.","text":"The point in time corresponding to this timestamp, represented as the number of milliseconds since Unix epoch 1970-01-01T00:00:00Z.\n"},"type":{"type":"intrinsic","name":"number"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1490,"character":12}]},{"id":1734,"name":"fromDate","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1735,"name":"fromDate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new timestamp from the given JavaScript [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)."},"parameters":[{"id":1736,"name":"date","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The date to initialize the `Timestamp` from.\n"},"type":{"type":"reference","name":"Date"}}],"type":{"type":"reference","name":"Timestamp","id":1733}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1437,"character":19}]},{"id":1737,"name":"fromMillis","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1738,"name":"fromMillis","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new timestamp from the given number of milliseconds."},"parameters":[{"id":1739,"name":"milliseconds","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Number of milliseconds since Unix epoch 1970-01-01T00:00:00Z.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Timestamp","id":1733}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1444,"character":21}]},{"id":1740,"name":"now","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":1741,"name":"now","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new timestamp with the current date, with millisecond precision."},"type":{"type":"reference","name":"Timestamp","id":1733}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1449,"character":14}]}],"groups":[{"title":"Constructors","kind":512,"children":[1742]},{"title":"Properties","kind":1024,"children":[1746,1747]},{"title":"Methods","kind":2048,"children":[1748,1751,1753,1734,1737,1740]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1431,"character":24}]},{"id":1308,"name":"CollectionReference","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `CollectionReference` object can be used for adding documents, getting document references, and querying for\ndocuments (using the methods inherited from `Query`)."},"children":[{"id":1309,"name":"id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The collection's identifier."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":97,"character":6}],"type":{"type":"intrinsic","name":"string"}},{"id":1310,"name":"parent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A reference to the containing `DocumentReference` if this is a subcollection. If this isn't a\nsubcollection, the reference is null."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":103,"character":10}],"type":{"type":"union","types":[{"type":"reference","name":"DocumentReference","id":1427},{"type":"intrinsic","name":"null"}]}},{"id":1311,"name":"path","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A string representing the path of the referenced collection (relative to the root of the database)."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":108,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":1312,"name":"add","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1313,"name":"add","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Add a new document to this collection with the specified data, assigning it a document ID automatically.","text":"#### Example\n\n```js\nconst documentRef = await firebase.firestore().collection('users').add({\n  name: 'Ada Lovelace',\n  age: 30,\n});\n```\n"},"parameters":[{"id":1314,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An Object containing the data for the new document.\n"},"type":{"type":"reflection","declaration":{"id":1315,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1316,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1317,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":124,"character":13}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"DocumentReference","id":1427}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":124,"character":7}]},{"id":1318,"name":"doc","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1319,"name":"doc","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Get a DocumentReference for the document within the collection at the specified path. If no\npath is specified, an automatically-generated unique ID will be used for the returned DocumentReference.","text":"#### Example\n\n```js\nawait firebase.firestore().collection('users').doc('alovelace').set({\n  name: 'Ada Lovelace',\n  age: 30,\n});\n```\n"},"parameters":[{"id":1320,"name":"documentPath","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A slash-separated path to a document.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"DocumentReference","id":1427}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":141,"character":7}]},{"id":1321,"name":"endAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1322,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends at the provided document (inclusive). The end\nposition is relative to the order of the query. The document must contain all of the\nfields provided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endAt(user);\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1323,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to end at.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1596}},{"id":1324,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends at the provided fields relative to the order of the query.\nThe order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is 30 or less\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endAt(30);\n```\n"},"parameters":[{"id":1325,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to end this query at, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1596}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":852,"character":9},{"fileName":"packages/firestore/lib/index.d.ts","line":870,"character":9}],"inheritedFrom":{"type":"reference","name":"Query.endAt","id":1596}},{"id":1326,"name":"endBefore","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1327,"name":"endBefore","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends before the provided document (exclusive). The end\nposition is relative to the order of the query. The document must contain all of the fields\nprovided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to, but not including, a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endBefore(user);\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1328,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to end before.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.endBefore","id":1601}},{"id":1329,"name":"endBefore","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends before the provided fields relative to the order of\nthe query. The order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is 29 or less\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endBefore(30);\n```\n"},"parameters":[{"id":1330,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to end this query before, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.endBefore","id":1601}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":893,"character":13},{"fileName":"packages/firestore/lib/index.d.ts","line":911,"character":13}],"inheritedFrom":{"type":"reference","name":"Query.endBefore","id":1601}},{"id":1331,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1332,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Executes the query and returns the results as a QuerySnapshot.","text":"Note: By default, get() attempts to provide up-to-date data when possible by waiting for data from the server,\nbut it may return cached data or fail if you are offline and the server cannot be reached. This behavior can be\naltered via the `GetOptions` parameter.\n\n#### Example\n\n```js\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .get({\n    source: 'server',\n  });\n```\n"},"parameters":[{"id":1333,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An object to configure the get behavior.\n"},"type":{"type":"reference","name":"GetOptions","id":1593}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"QuerySnapshot","id":1697}]},"inheritedFrom":{"type":"reference","name":"Query.get","id":1606}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":933,"character":7}],"inheritedFrom":{"type":"reference","name":"Query.get","id":1606}},{"id":1334,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1335,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this Query is equal to the provided one.","text":"#### Example\n\n```js\nconst query = firebase.firestore()\n  .collection('users')\n  .orderBy('age');\n\n// false\nquery.isEqual(\n  firebase.firestore()\n    .collection('users')\n    .orderBy('name')\n);\n```\n"},"parameters":[{"id":1336,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `Query` to compare against.\n"},"type":{"type":"reference","name":"Query","id":1595}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","name":"Query.isEqual","id":1609}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":955,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.isEqual","id":1609}},{"id":1337,"name":"limit","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1338,"name":"limit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query where the results are limited to the specified number of documents.","text":"#### Example\n\n```js\n// Get 10 users in order of age\nconst querySnapshot = firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .limit(10)\n  .get();\n```\n"},"parameters":[{"id":1339,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of items to return.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.limit","id":1612}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":973,"character":9}],"inheritedFrom":{"type":"reference","name":"Query.limit","id":1612}},{"id":1340,"name":"onSnapshot","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1341,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events.","text":"> Although an `onCompletion` callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot({\n    error: (e) => console.error(e),\n    next: (querySnapshot) => {},\n  });\n\nunsubscribe();\n```\n"},"parameters":[{"id":1342,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A single object containing `next` and `error` callbacks.\n"},"type":{"type":"reflection","declaration":{"id":1343,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1344,"name":"complete","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":997,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1345,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1346,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1347,"name":"error","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":998,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1348,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1349,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1350,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1351,"name":"next","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":999,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1352,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1353,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1354,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"groups":[{"title":"Variables","kind":32,"children":[1344,1347,1351]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":996,"character":24}]}}}],"type":{"type":"reflection","declaration":{"id":1355,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1356,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1000,"character":7}]}},"inheritedFrom":{"type":"reference","name":"Query.onSnapshot","id":1615}},{"id":1357,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events with snapshot listener options.","text":"> Although an `onCompletion` callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot({\n    includeMetadataChanges: true,\n  }, {\n    error: (e) => console.error(e),\n    next: (querySnapshot) => {},\n  });\n\nunsubscribe();\n```\n"},"parameters":[{"id":1358,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options controlling the listen behavior."},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}},{"id":1359,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A single object containing `next` and `error` callbacks.\n"},"type":{"type":"reflection","declaration":{"id":1360,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1361,"name":"complete","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1029,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1362,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1363,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1364,"name":"error","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1030,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1365,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1366,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1367,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1368,"name":"next","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1031,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1369,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1370,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1371,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"groups":[{"title":"Variables","kind":32,"children":[1361,1364,1368]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1028,"character":15}]}}}],"type":{"type":"reflection","declaration":{"id":1372,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1373,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1033,"character":6}]}},"inheritedFrom":{"type":"reference","name":"Query.onSnapshot","id":1615}},{"id":1374,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events.","text":"> Although an `onCompletion` callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot(\n    (querySnapshot) => {}, // onNext\n    (error) => console.error(error), // onError\n  );\n\nunsubscribe();\n```"},"parameters":[{"id":1375,"name":"onNext","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called every time a new `QuerySnapshot` is available."},"type":{"type":"reflection","declaration":{"id":1376,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1377,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1378,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1058,"character":13}]}}},{"id":1379,"name":"onError","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback to be called if the listen fails or is cancelled. No further callbacks will occur."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1380,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1381,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1382,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1383,"name":"onCompletion","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional function which will never be called.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1384,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1385,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reflection","declaration":{"id":1386,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1387,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1061,"character":6}]}},"inheritedFrom":{"type":"reference","name":"Query.onSnapshot","id":1615}},{"id":1388,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events with snapshot listener options.","text":"NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot(\n    { includeMetadataChanges: true }, // SnapshotListenerOptions\n    (querySnapshot) => {}, // onNext\n    (error) => console.error(error), // onError\n  );\n\nunsubscribe();\n```"},"parameters":[{"id":1389,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options controlling the listen behavior."},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}},{"id":1390,"name":"onNext","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called every time a new `QuerySnapshot` is available."},"type":{"type":"reflection","declaration":{"id":1391,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1392,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1393,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1089,"character":13}]}}},{"id":1394,"name":"onError","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback to be called if the listen fails or is cancelled. No further callbacks will occur."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1395,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1396,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1397,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1398,"name":"onCompletion","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional function which will never be called.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1399,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1400,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reflection","declaration":{"id":1401,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1402,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1092,"character":6}]}},"inheritedFrom":{"type":"reference","name":"Query.onSnapshot","id":1615}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":996,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1026,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1057,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1087,"character":14}],"inheritedFrom":{"type":"reference","name":"Query.onSnapshot","id":1615}},{"id":1403,"name":"orderBy","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1404,"name":"orderBy","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.","text":"* #### Example\n\n#### Example\n\n```js\n// Get users in order of age, descending\nconst querySnapshot = firebase.firestore()\n  .collection('users')\n  .orderBy('age', 'desc')\n  .get();\n```\n"},"parameters":[{"id":1405,"name":"fieldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The field to sort by. Either a string or FieldPath instance."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1406,"name":"directionStr","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional direction to sort by (`asc` or `desc`). If not specified, order will be ascending.\n"},"type":{"type":"union","types":[{"type":"stringLiteral","value":"asc"},{"type":"stringLiteral","value":"desc"}]}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.orderBy","id":1678}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1112,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.orderBy","id":1678}},{"id":1407,"name":"startAfter","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1408,"name":"startAfter","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts after the provided document (exclusive). The start\nposition is relative to the order of the query. The document must contain all of the fields\nprovided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to, but not including, a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAfter(user)\n  .get();\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1409,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to start after.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.startAfter","id":1682}},{"id":1410,"name":"startAfter","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts after the provided fields relative to the order of\nthe query. The order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is above 30\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAfter(30)\n  .get();\n```\n"},"parameters":[{"id":1411,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to start this query after, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.startAfter","id":1682}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1136,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1155,"character":14}],"inheritedFrom":{"type":"reference","name":"Query.startAfter","id":1682}},{"id":1412,"name":"startAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1413,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts at the provided document (inclusive). The start\nposition is relative to the order of the query. The document must contain all of the\nfields provided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAt(user)\n  .get();\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1414,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to start at.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1687}},{"id":1415,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts at the provided fields relative to the order of the query.\nThe order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is 30 or above\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAt(30)\n  .get();\n```\n"},"parameters":[{"id":1416,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to start this query at, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1687}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1179,"character":11},{"fileName":"packages/firestore/lib/index.d.ts","line":1198,"character":11}],"inheritedFrom":{"type":"reference","name":"Query.startAt","id":1687}},{"id":1417,"name":"where","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1418,"name":"where","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query with the additional filter that documents must contain the specified field and\nthe value should satisfy the relation constraint provided.","text":"#### Example\n\n```js\n// Get all users who's age is 30 or above\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .where('age', '>=', 30);\n  .get();\n```\n"},"parameters":[{"id":1419,"name":"fieldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The path to compare."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1420,"name":"opStr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The operation string (e.g \"<\", \"<=\", \"==\", \">\", \">=\", \"array-contains\", \"array-contains-any\", \"in\")."},"type":{"type":"reference","name":"WhereFilterOp","id":1849}},{"id":1421,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The comparison value.\n"},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"reference","name":"Query","id":1595},"inheritedFrom":{"type":"reference","name":"Query.where","id":1692}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1218,"character":9}],"inheritedFrom":{"type":"reference","name":"Query.where","id":1692}}],"groups":[{"title":"Properties","kind":1024,"children":[1309,1310,1311]},{"title":"Methods","kind":2048,"children":[1312,1318,1321,1326,1331,1334,1337,1340,1403,1407,1412,1417]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":93,"character":38}],"extendedTypes":[{"type":"reference","name":"Query","id":1595}]},{"id":1422,"name":"DocumentChange","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A DocumentChange represents a change to the documents matching a query. It contains the document affected and the\ntype of change that occurred."},"children":[{"id":1423,"name":"doc","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The document affected by this change."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":152,"character":7}],"type":{"type":"reference","name":"QueryDocumentSnapshot","id":1540}},{"id":1424,"name":"newIndex","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The index of the changed document in the result set immediately after this `DocumentChange`\n(i.e. supposing that all prior `DocumentChange` objects and the current `DocumentChange` object have been applied).\nIs -1 for 'removed' events."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":159,"character":12}],"type":{"type":"intrinsic","name":"number"}},{"id":1425,"name":"oldIndex","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The index of the changed document in the result set immediately prior to this `DocumentChange` (i.e.\nsupposing that all prior `DocumentChange` objects have been applied). Is -1 for 'added' events."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":165,"character":12}],"type":{"type":"intrinsic","name":"number"}},{"id":1426,"name":"type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The type of change ('added', 'modified', or 'removed')."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":170,"character":8}],"type":{"type":"reference","name":"DocumentChangeType","id":1844}}],"groups":[{"title":"Properties","kind":1024,"children":[1423,1424,1425,1426]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":148,"character":33}]},{"id":1427,"name":"DocumentReference","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `DocumentReference` refers to a document location in a Firestore database and can be used to write, read, or listen\nto the location. The document at the referenced location may or may not exist. A `DocumentReference` can also be used\nto create a `CollectionReference` to a subcollection."},"children":[{"id":1428,"name":"firestore","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Firestore instance the document is in. This is useful for performing transactions, for example."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":205,"character":13}],"type":{"type":"reference","name":"Module","id":1818}},{"id":1429,"name":"id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The document's identifier within its collection."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":210,"character":6}],"type":{"type":"intrinsic","name":"string"}},{"id":1430,"name":"parent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Collection this `DocumentReference` belongs to."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":215,"character":10}],"type":{"type":"reference","name":"CollectionReference","id":1308}},{"id":1431,"name":"path","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A string representing the path of the referenced document (relative to the root of the database)."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":220,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":1432,"name":"collection","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1433,"name":"collection","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a `CollectionReference` instance that refers to the collection at the specified path.","text":"#### Example\n\n```js\nconst collectionRef = firebase.firestore().doc('users/alovelace').collection('orders');\n```\n"},"parameters":[{"id":1434,"name":"collectionPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A slash-separated path to a collection.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"CollectionReference","id":1308}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":233,"character":14}]},{"id":1435,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1436,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deletes the document referred to by this DocumentReference.","text":"#### Example\n\n```js\nawait firebase.firestore().doc('users/alovelace').delete();\n```\n\nThe Promise is resolved once the document has been successfully deleted from the backend\n(Note that it won't resolve while you're offline).\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":247,"character":10}]},{"id":1437,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1438,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Reads the document referred to by this DocumentReference.","text":"Note: By default, get() attempts to provide up-to-date data when possible by waiting for data\nfrom the server, but it may return cached data or fail if you are offline and the server cannot\nbe reached. This behavior can be altered via the GetOptions parameter.\n\n#### Example\n\n```js\nawait firebase.firestore().doc('users/alovelace').get({\n  source: 'server',\n});\n```\n"},"parameters":[{"id":1439,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An object to configure the get behavior.\n"},"type":{"type":"reference","name":"GetOptions","id":1593}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"DocumentSnapshot","id":1523}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":266,"character":7}]},{"id":1440,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1441,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this DocumentReference is equal to the provided one.","text":"#### Example\n\n```js\nconst alovelace = firebase.firestore().doc('users/alovelace');\nconst dsmith = firebase.firestore().doc('users/dsmith');\n\n// false\nalovelace.isEqual(dsmith);\n``\n\n@param other The `DocumentReference` to compare against.\n"},"parameters":[{"id":1442,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"DocumentReference","id":1427}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":283,"character":11}]},{"id":1443,"name":"onSnapshot","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1444,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for DocumentSnapshot events.","text":"NOTE: Although an complete callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().doc('users/alovelace')\n  .onSnapshot({\n    error: (e) => console.error(e),\n    next: (documentSnapshot) => {},\n  });\n\nunsubscribe();\n```\n"},"parameters":[{"id":1445,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A single object containing `next` and `error` callbacks.\n"},"type":{"type":"reflection","declaration":{"id":1446,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1447,"name":"complete","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":307,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1448,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1449,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1450,"name":"error","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":308,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1451,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1452,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1453,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1454,"name":"next","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":309,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1455,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1456,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1457,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"groups":[{"title":"Variables","kind":32,"children":[1447,1450,1454]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":306,"character":24}]}}}],"type":{"type":"reflection","declaration":{"id":1458,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1459,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":310,"character":7}]}}},{"id":1460,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for DocumentSnapshot events with snapshot listener options.","text":"NOTE: Although an complete callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().doc('users/alovelace')\n  .onSnapshot({\n    includeMetadataChanges: true,\n  }, {\n    error: (e) => console.error(e),\n    next: (documentSnapshot) => {},\n  });\n\nunsubscribe();\n```\n"},"parameters":[{"id":1461,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options controlling the listen behavior."},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}},{"id":1462,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A single object containing `next` and `error` callbacks.\n"},"type":{"type":"reflection","declaration":{"id":1463,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1464,"name":"complete","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":339,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1465,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1466,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1467,"name":"error","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":340,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1468,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1469,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1470,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1471,"name":"next","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":341,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1472,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1473,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1474,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"groups":[{"title":"Variables","kind":32,"children":[1464,1467,1471]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":338,"character":15}]}}}],"type":{"type":"reflection","declaration":{"id":1475,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1476,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":343,"character":6}]}}},{"id":1477,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for DocumentSnapshot events.","text":"NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().doc('users/alovelace')\n  .onSnapshot(\n    (documentSnapshot) => {}, // onNext\n    (error) => console.error(error), // onError\n  );\n\nunsubscribe();\n```"},"parameters":[{"id":1478,"name":"onNext","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called every time a new `DocumentSnapshot` is available."},"type":{"type":"reflection","declaration":{"id":1479,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1480,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1481,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":368,"character":13}]}}},{"id":1482,"name":"onError","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback to be called if the listen fails or is cancelled. No further callbacks will occur."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1483,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1484,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1485,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1486,"name":"onCompletion","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional function which will never be called.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1487,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1488,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reflection","declaration":{"id":1489,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1490,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":371,"character":6}]}}},{"id":1491,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for DocumentSnapshot events with snapshot listener options.","text":"NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().doc('users/alovelace')\n  .onSnapshot(\n    { includeMetadataChanges: true }, // SnapshotListenerOptions\n    (documentSnapshot) => {}, // onNext\n    (error) => console.error(error), // onError\n  );\n\nunsubscribe();\n```"},"parameters":[{"id":1492,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options controlling the listen behavior."},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}},{"id":1493,"name":"onNext","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called every time a new `DocumentSnapshot` is available."},"type":{"type":"reflection","declaration":{"id":1494,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1495,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1496,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":399,"character":13}]}}},{"id":1497,"name":"onError","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback to be called if the listen fails or is cancelled. No further callbacks will occur."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1498,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1499,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1500,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1501,"name":"onCompletion","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional function which will never be called.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1502,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1503,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reflection","declaration":{"id":1504,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1505,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":402,"character":6}]}}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":306,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":336,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":367,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":397,"character":14}]},{"id":1506,"name":"set","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1507,"name":"set","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes to the document referred to by this DocumentReference. If the document does not yet\nexist, it will be created. If you pass SetOptions, the provided data can be merged into an\nexisting document.","text":"#### Example\n\n```js\nconst user = firebase.firestore().doc('users/alovelace');\n\n// Set new data\nawait user.set({\n  name: 'Ada Lovelace',\n  age: 30,\n  city: 'LON',\n});\n``\n\n@param data A map of the fields and values for the document.\n@param options An object to configure the set behavior.\n"},"parameters":[{"id":1508,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":1509,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1510,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1511,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":425,"character":13}]}}},{"id":1512,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"SetOptions","id":1717}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":425,"character":7}]},{"id":1513,"name":"update","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1514,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates fields in the document referred to by this `DocumentReference`. The update will fail\nif applied to a document that does not exist.","text":"#### Example\n\n```\nconst user = firebase.firestore().doc('users/alovelace');\n\n// Update age but leave other fields untouched\nawait user.update({\n  age: 31,\n});\n```\n"},"parameters":[{"id":1515,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.\n"},"type":{"type":"reflection","declaration":{"id":1516,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1517,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1518,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":444,"character":16}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}},{"id":1519,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates fields in the document referred to by this DocumentReference. The update will fail if\napplied to a document that does not exist.","text":"#### Example\n\n```\nconst user = firebase.firestore().doc('users/alovelace');\n\n// Update age & city but leve other fields untouched\nawait user.update('age', 31, 'city', 'SF');\n```\n"},"parameters":[{"id":1520,"name":"field","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The first field to update."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1521,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The first value."},"type":{"type":"intrinsic","name":"any"}},{"id":1522,"name":"moreFieldsAndValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"Additional key value pairs.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":444,"character":10},{"fileName":"packages/firestore/lib/index.d.ts","line":463,"character":10}]}],"groups":[{"title":"Properties","kind":1024,"children":[1428,1429,1430,1431]},{"title":"Methods","kind":2048,"children":[1432,1435,1437,1440,1443,1506,1513]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":201,"character":36}]},{"id":1523,"name":"DocumentSnapshot","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A DocumentSnapshot contains data read from a document in your Firestore database. The data can be extracted with\n.`data()` or `.get(:field)` to get a specific field.","text":"For a DocumentSnapshot that points to a non-existing document, any data access will return 'undefined'.\nYou can use the `exists` property to explicitly verify a document's existence.\n"},"children":[{"id":1524,"name":"exists","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Property of the `DocumentSnapshot` that signals whether or not the data exists. True if the document exists."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":477,"character":10}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1525,"name":"id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Property of the `DocumentSnapshot` that provides the document's ID."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":482,"character":6}],"type":{"type":"intrinsic","name":"string"}},{"id":1526,"name":"metadata","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Metadata about the `DocumentSnapshot`, including information about its source and local modifications."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":487,"character":12}],"type":{"type":"reference","name":"SnapshotMetadata","id":1727}},{"id":1527,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The `DocumentReference` for the document included in the `DocumentSnapshot`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":492,"character":7}],"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1528,"name":"data","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1529,"name":"data","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Retrieves all fields in the document as an Object. Returns 'undefined' if the document doesn't exist.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\nconsole.log('User', user.data());\n```\n"},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":1530,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1531,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1532,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":505,"character":11}]}},{"type":"intrinsic","name":"undefined"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":505,"character":8}]},{"id":1533,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1534,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Retrieves the field specified by fieldPath. Returns undefined if the document or field doesn't exist.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\nconsole.log('Address ZIP Code', user.get('address.zip'));\n```\n"},"typeParameter":[{"id":1535,"name":"fieldType","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","name":"DocumentFieldType","id":1845}}],"parameters":[{"id":1536,"name":"fieldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The path (e.g. 'foo' or 'foo.bar') to a specific field.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}}],"type":{"type":"typeParameter","name":"fieldType","constraint":{"type":"reference","name":"DocumentFieldType","id":1845}}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":520,"character":7}]},{"id":1537,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1538,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `DocumentSnapshot` is equal to the provided one.","text":"#### Example\n\n```js\nconst user1 = await firebase.firestore().doc('users/alovelace').get();\nconst user2 = await firebase.firestore().doc('users/dsmith').get();\n\n// false\nuser1.isEqual(user2);\n```\n"},"parameters":[{"id":1539,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `DocumentSnapshot` to compare against.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":537,"character":11}]}],"groups":[{"title":"Properties","kind":1024,"children":[1524,1525,1526,1527]},{"title":"Methods","kind":2048,"children":[1528,1533,1537]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":473,"character":35}],"extendedBy":[{"type":"reference","name":"QueryDocumentSnapshot","id":1540}]},{"id":1593,"name":"GetOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An options object that configures the behavior of get() calls on DocumentReference and Query.\nBy providing a GetOptions object, these methods can be configured to fetch results only from the\nserver, only from the local cache or attempt to fetch results from the server and fall back to the\ncache (which is the default)."},"children":[{"id":1594,"name":"source","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Describes whether we should get from server or cache.","text":"Setting to `default` (or not setting at all), causes Firestore to try to retrieve an up-to-date (server-retrieved)\nsnapshot, but fall back to returning cached data if the server can't be reached.\n\nSetting to `server` causes Firestore to avoid the cache, generating an error if the server cannot be reached. Note\nthat the cache will still be updated if the server request succeeds. Also note that latency-compensation still\ntakes effect, so any pending write operations will be visible in the returned data (merged into the server-provided data).\n\nSetting to `cache` causes Firestore to immediately return a value from the cache, ignoring the server completely\n(implying that the returned value may be stale with respect to the value on the server.) If there is no data in the\ncache to satisfy the `get()` call, `DocumentReference.get()` will return an error and `QuerySnapshot.get()` will return an\nempty `QuerySnapshot` with no documents.\n"},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":823,"character":10}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"default"},{"type":"stringLiteral","value":"server"},{"type":"stringLiteral","value":"cache"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1594]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":807,"character":29}]},{"id":1595,"name":"Query","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A Query refers to a `Query` which you can read or listen to. You can also construct refined `Query` objects by\nadding filters and ordering."},"children":[{"id":1596,"name":"endAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1597,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends at the provided document (inclusive). The end\nposition is relative to the order of the query. The document must contain all of the\nfields provided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endAt(user);\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1598,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to end at.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595}},{"id":1599,"name":"endAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends at the provided fields relative to the order of the query.\nThe order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is 30 or less\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endAt(30);\n```\n"},"parameters":[{"id":1600,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to end this query at, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":852,"character":9},{"fileName":"packages/firestore/lib/index.d.ts","line":870,"character":9}]},{"id":1601,"name":"endBefore","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1602,"name":"endBefore","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends before the provided document (exclusive). The end\nposition is relative to the order of the query. The document must contain all of the fields\nprovided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to, but not including, a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endBefore(user);\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1603,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to end before.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595}},{"id":1604,"name":"endBefore","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that ends before the provided fields relative to the order of\nthe query. The order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is 29 or less\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .endBefore(30);\n```\n"},"parameters":[{"id":1605,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to end this query before, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":893,"character":13},{"fileName":"packages/firestore/lib/index.d.ts","line":911,"character":13}]},{"id":1606,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1607,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Executes the query and returns the results as a QuerySnapshot.","text":"Note: By default, get() attempts to provide up-to-date data when possible by waiting for data from the server,\nbut it may return cached data or fail if you are offline and the server cannot be reached. This behavior can be\naltered via the `GetOptions` parameter.\n\n#### Example\n\n```js\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .get({\n    source: 'server',\n  });\n```\n"},"parameters":[{"id":1608,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An object to configure the get behavior.\n"},"type":{"type":"reference","name":"GetOptions","id":1593}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"QuerySnapshot","id":1697}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":933,"character":7}]},{"id":1609,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1610,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this Query is equal to the provided one.","text":"#### Example\n\n```js\nconst query = firebase.firestore()\n  .collection('users')\n  .orderBy('age');\n\n// false\nquery.isEqual(\n  firebase.firestore()\n    .collection('users')\n    .orderBy('name')\n);\n```\n"},"parameters":[{"id":1611,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `Query` to compare against.\n"},"type":{"type":"reference","name":"Query","id":1595}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":955,"character":11}]},{"id":1612,"name":"limit","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1613,"name":"limit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query where the results are limited to the specified number of documents.","text":"#### Example\n\n```js\n// Get 10 users in order of age\nconst querySnapshot = firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .limit(10)\n  .get();\n```\n"},"parameters":[{"id":1614,"name":"limit","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The maximum number of items to return.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":973,"character":9}]},{"id":1615,"name":"onSnapshot","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1616,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events.","text":"> Although an `onCompletion` callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot({\n    error: (e) => console.error(e),\n    next: (querySnapshot) => {},\n  });\n\nunsubscribe();\n```\n"},"parameters":[{"id":1617,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A single object containing `next` and `error` callbacks.\n"},"type":{"type":"reflection","declaration":{"id":1618,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1619,"name":"complete","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":997,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1620,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1621,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1622,"name":"error","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":998,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1623,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1624,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1625,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1626,"name":"next","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":999,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1627,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1628,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1629,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"groups":[{"title":"Variables","kind":32,"children":[1619,1622,1626]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":996,"character":24}]}}}],"type":{"type":"reflection","declaration":{"id":1630,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1631,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1000,"character":7}]}}},{"id":1632,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events with snapshot listener options.","text":"> Although an `onCompletion` callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot({\n    includeMetadataChanges: true,\n  }, {\n    error: (e) => console.error(e),\n    next: (querySnapshot) => {},\n  });\n\nunsubscribe();\n```\n"},"parameters":[{"id":1633,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options controlling the listen behavior."},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}},{"id":1634,"name":"observer","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A single object containing `next` and `error` callbacks.\n"},"type":{"type":"reflection","declaration":{"id":1635,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1636,"name":"complete","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1029,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1637,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1638,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1639,"name":"error","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1030,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1640,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1641,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1642,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1643,"name":"next","kind":32,"kindString":"Variable","flags":{"isOptional":true},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1031,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1644,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1645,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1646,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}]}}]}}],"groups":[{"title":"Variables","kind":32,"children":[1636,1639,1643]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1028,"character":15}]}}}],"type":{"type":"reflection","declaration":{"id":1647,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1648,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1033,"character":6}]}}},{"id":1649,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events.","text":"> Although an `onCompletion` callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot(\n    (querySnapshot) => {}, // onNext\n    (error) => console.error(error), // onError\n  );\n\nunsubscribe();\n```"},"parameters":[{"id":1650,"name":"onNext","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called every time a new `QuerySnapshot` is available."},"type":{"type":"reflection","declaration":{"id":1651,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1652,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1653,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1058,"character":13}]}}},{"id":1654,"name":"onError","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback to be called if the listen fails or is cancelled. No further callbacks will occur."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1655,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1656,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1657,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1658,"name":"onCompletion","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional function which will never be called.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1659,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1660,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reflection","declaration":{"id":1661,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1662,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1061,"character":6}]}}},{"id":1663,"name":"onSnapshot","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Attaches a listener for `QuerySnapshot` events with snapshot listener options.","text":"NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.\n\nReturns an unsubscribe function to stop listening to events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.firestore().collection('users')\n  .onSnapshot(\n    { includeMetadataChanges: true }, // SnapshotListenerOptions\n    (querySnapshot) => {}, // onNext\n    (error) => console.error(error), // onError\n  );\n\nunsubscribe();\n```"},"parameters":[{"id":1664,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options controlling the listen behavior."},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}},{"id":1665,"name":"onNext","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called every time a new `QuerySnapshot` is available."},"type":{"type":"reflection","declaration":{"id":1666,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1667,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1668,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1089,"character":13}]}}},{"id":1669,"name":"onError","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"A callback to be called if the listen fails or is cancelled. No further callbacks will occur."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1670,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1671,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1672,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Error"}}],"type":{"type":"intrinsic","name":"void"}}]}}]}},{"id":1673,"name":"onCompletion","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional function which will never be called.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1674,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1675,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}]}}],"type":{"type":"reflection","declaration":{"id":1676,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1677,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1092,"character":6}]}}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":996,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1026,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1057,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1087,"character":14}]},{"id":1678,"name":"orderBy","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1679,"name":"orderBy","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.","text":"* #### Example\n\n#### Example\n\n```js\n// Get users in order of age, descending\nconst querySnapshot = firebase.firestore()\n  .collection('users')\n  .orderBy('age', 'desc')\n  .get();\n```\n"},"parameters":[{"id":1680,"name":"fieldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The field to sort by. Either a string or FieldPath instance."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1681,"name":"directionStr","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional direction to sort by (`asc` or `desc`). If not specified, order will be ascending.\n"},"type":{"type":"union","types":[{"type":"stringLiteral","value":"asc"},{"type":"stringLiteral","value":"desc"}]}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1112,"character":11}]},{"id":1682,"name":"startAfter","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1683,"name":"startAfter","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts after the provided document (exclusive). The start\nposition is relative to the order of the query. The document must contain all of the fields\nprovided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to, but not including, a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAfter(user)\n  .get();\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1684,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to start after.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595}},{"id":1685,"name":"startAfter","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts after the provided fields relative to the order of\nthe query. The order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is above 30\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAfter(30)\n  .get();\n```\n"},"parameters":[{"id":1686,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to start this query after, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1136,"character":14},{"fileName":"packages/firestore/lib/index.d.ts","line":1155,"character":14}]},{"id":1687,"name":"startAt","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1688,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts at the provided document (inclusive). The start\nposition is relative to the order of the query. The document must contain all of the\nfields provided in the orderBy of this query.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\n// Get all users up to a specific user in order of age\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAt(user)\n  .get();\n```\n\n> Cursor snapshot queries have limitations. Please see [Query limitations](/query-limitations) for more information.\n"},"parameters":[{"id":1689,"name":"snapshot","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The snapshot of the document to start at.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"reference","name":"Query","id":1595}},{"id":1690,"name":"startAt","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query that starts at the provided fields relative to the order of the query.\nThe order of the field values must match the order of the order by clauses of the query.","text":"#### Example\n\n```js\n// Get all users who's age is 30 or above\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .orderBy('age')\n  .startAt(30)\n  .get();\n```\n"},"parameters":[{"id":1691,"name":"fieldValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The field values to start this query at, in order of the query's order by.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1179,"character":11},{"fileName":"packages/firestore/lib/index.d.ts","line":1198,"character":11}]},{"id":1692,"name":"where","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1693,"name":"where","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates and returns a new Query with the additional filter that documents must contain the specified field and\nthe value should satisfy the relation constraint provided.","text":"#### Example\n\n```js\n// Get all users who's age is 30 or above\nconst querySnapshot = await firebase.firestore()\n  .collection('users')\n  .where('age', '>=', 30);\n  .get();\n```\n"},"parameters":[{"id":1694,"name":"fieldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The path to compare."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1695,"name":"opStr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The operation string (e.g \"<\", \"<=\", \"==\", \">\", \">=\", \"array-contains\", \"array-contains-any\", \"in\")."},"type":{"type":"reference","name":"WhereFilterOp","id":1849}},{"id":1696,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The comparison value.\n"},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"reference","name":"Query","id":1595}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1218,"character":9}]}],"groups":[{"title":"Methods","kind":2048,"children":[1596,1601,1606,1609,1612,1615,1678,1682,1687,1692]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":830,"character":24}],"extendedBy":[{"type":"reference","name":"CollectionReference","id":1308}]},{"id":1540,"name":"QueryDocumentSnapshot","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A QueryDocumentSnapshot contains data read from a document in your Firestore database as part of a query.\nThe document is guaranteed to exist and its data can be extracted with .data() or .get(:field) to get a specific field.","text":"A QueryDocumentSnapshot offers the same API surface as a DocumentSnapshot.\nSince query results contain only existing documents, the exists property will always be true and data() will never return 'undefined'.\n"},"children":[{"id":1541,"name":"exists","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A QueryDocumentSnapshot is always guaranteed to exist."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":551,"character":10}],"type":{"type":"intrinsic","name":"true"},"overwrites":{"type":"reference","name":"DocumentSnapshot.exists","id":1524}},{"id":1547,"name":"id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Property of the `DocumentSnapshot` that provides the document's ID."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":482,"character":6}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.id","id":1525}},{"id":1548,"name":"metadata","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Metadata about the `DocumentSnapshot`, including information about its source and local modifications."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":487,"character":12}],"type":{"type":"reference","name":"SnapshotMetadata","id":1727},"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.metadata","id":1526}},{"id":1549,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The `DocumentReference` for the document included in the `DocumentSnapshot`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":492,"character":7}],"type":{"type":"reference","name":"DocumentReference","id":1427},"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.ref","id":1527}},{"id":1542,"name":"data","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1543,"name":"data","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Retrieves all fields in the document as an Object.","text":"#### Example\n\n```js\nconst users = await firebase.firestore().collection('users').get();\n\nfor (const user of users.docs) {\n  console.log('User', user.data());\n}\n```\n"},"type":{"type":"reflection","declaration":{"id":1544,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1545,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1546,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":566,"character":11}]}},"overwrites":{"type":"reference","name":"DocumentSnapshot.data","id":1528}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":566,"character":8}],"overwrites":{"type":"reference","name":"DocumentSnapshot.data","id":1528}},{"id":1550,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1551,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Retrieves the field specified by fieldPath. Returns undefined if the document or field doesn't exist.","text":"#### Example\n\n```js\nconst user = await firebase.firestore().doc('users/alovelace').get();\n\nconsole.log('Address ZIP Code', user.get('address.zip'));\n```\n"},"typeParameter":[{"id":1552,"name":"fieldType","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","name":"DocumentFieldType","id":1845}}],"parameters":[{"id":1553,"name":"fieldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The path (e.g. 'foo' or 'foo.bar') to a specific field.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}}],"type":{"type":"typeParameter","name":"fieldType","constraint":{"type":"reference","name":"DocumentFieldType","id":1845}},"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.get","id":1533}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":520,"character":7}],"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.get","id":1533}},{"id":1554,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1555,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `DocumentSnapshot` is equal to the provided one.","text":"#### Example\n\n```js\nconst user1 = await firebase.firestore().doc('users/alovelace').get();\nconst user2 = await firebase.firestore().doc('users/dsmith').get();\n\n// false\nuser1.isEqual(user2);\n```\n"},"parameters":[{"id":1556,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `DocumentSnapshot` to compare against.\n"},"type":{"type":"reference","name":"DocumentSnapshot","id":1523}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.isEqual","id":1537}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":537,"character":11}],"inheritedFrom":{"type":"reference","name":"DocumentSnapshot.isEqual","id":1537}}],"groups":[{"title":"Properties","kind":1024,"children":[1541,1547,1548,1549]},{"title":"Methods","kind":2048,"children":[1542,1550,1554]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":547,"character":40}],"extendedTypes":[{"type":"reference","name":"DocumentSnapshot","id":1523}]},{"id":1697,"name":"QuerySnapshot","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `QuerySnapshot` contains zero or more `QueryDocumentSnapshot` objects representing the results of a query. The documents\ncan be accessed as an array via the `docs` property or enumerated using the `forEach` method. The number of documents\ncan be determined via the `empty` and `size` properties."},"children":[{"id":1698,"name":"docs","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An array of all the documents in the `QuerySnapshot`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1243,"character":8}],"type":{"type":"array","elementType":{"type":"reference","name":"QueryDocumentSnapshot","id":1540}}},{"id":1699,"name":"empty","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"True if there are no documents in the `QuerySnapshot`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1248,"character":9}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1700,"name":"metadata","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Metadata about this snapshot, concerning its source and if it has local modifications."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1253,"character":12}],"type":{"type":"reference","name":"SnapshotMetadata","id":1727}},{"id":1701,"name":"query","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The query on which you called get or `onSnapshot` in order to `get` this `QuerySnapshot`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1258,"character":9}],"type":{"type":"reference","name":"Query","id":1595}},{"id":1702,"name":"size","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The number of documents in the `QuerySnapshot`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1263,"character":8}],"type":{"type":"intrinsic","name":"number"}},{"id":1703,"name":"docChanges","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1704,"name":"docChanges","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an array of the documents changes since the last snapshot. If this is the first snapshot, all documents\nwill be in the list as added changes.","text":"To include metadata changes, ensure that the `onSnapshot()` method includes metadata changes.\n\n#### Example\n\n```js\nfirebase.firestore().collection('users')\n  .onSnapshot((querySnapshot) => {\n    console.log('Metadata Changes', querySnapshot.docChanges());\n  });\n```\n\n#### Example - With metadata changes\n\n```js\nfirebase.firestore().collection('users')\n  .onSnapshot({ includeMetadataChanges: true }, (querySnapshot) => {\n    console.log('Metadata Changes', querySnapshot.docChanges({\n      includeMetadataChanges: true,\n    }));\n  });\n```\n"},"parameters":[{"id":1705,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"`SnapshotListenOptions` that control whether metadata-only changes (i.e. only `DocumentSnapshot.metadata` changed) should trigger snapshot events.\n"},"type":{"type":"reference","name":"SnapshotListenOptions","id":1725}}],"type":{"type":"array","elementType":{"type":"reference","name":"DocumentChange","id":1422}}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1293,"character":14}]},{"id":1706,"name":"forEach","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1707,"name":"forEach","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Enumerates all of the documents in the `QuerySnapshot`.","text":"#### Example\n\n```js\nconst querySnapshot = await firebase.firestore().collection('users').get();\n\nquerySnapshot.forEach((queryDocumentSnapshot) => {\n  console.log('User', queryDocumentSnapshot.data());\n})\n```\n"},"parameters":[{"id":1708,"name":"callback","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A callback to be called with a `QueryDocumentSnapshot` for each document in the snapshot."},"type":{"type":"reflection","declaration":{"id":1709,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":1710,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1711,"name":"result","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"QueryDocumentSnapshot","id":1540}},{"id":1712,"name":"index","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1312,"character":21}]}}},{"id":1713,"name":"thisArg","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The `this` binding for the callback.\n"},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1312,"character":11}]},{"id":1714,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1715,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `QuerySnapshot` is equal to the provided one.","text":"#### Example\n\n```js\nconst querySnapshot1 = await firebase.firestore().collection('users').limit(5).get();\nconst querySnapshot2 = await firebase.firestore().collection('users').limit(10).get();\n\n// false\nquerySnapshot1.isEqual(querySnapshot2);\n```\n\n> This operation can be resource intensive when dealing with large datasets.\n"},"parameters":[{"id":1716,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `QuerySnapshot` to compare against.\n"},"type":{"type":"reference","name":"QuerySnapshot","id":1697}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1331,"character":11}]}],"groups":[{"title":"Properties","kind":1024,"children":[1698,1699,1700,1701,1702]},{"title":"Methods","kind":2048,"children":[1703,1706,1714]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1239,"character":32}]},{"id":1717,"name":"SetOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An options object that configures the behavior of set() calls in `DocumentReference`, `WriteBatch` and `Transaction`.\nThese calls can be configured to perform granular merges instead of overwriting the target documents in their entirety\nby providing a `SetOptions` with `merge: true`.","text":"Using both `merge` and `mergeFields` together will throw an error.\n"},"children":[{"id":1718,"name":"merge","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Changes the behavior of a `set()` call to only replace the values specified in its data argument.\nFields omitted from the `set()` call remain untouched."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1346,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":1719,"name":"mergeFields","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Changes the behavior of `set()` calls to only replace the specified field paths.\nAny field path that is not specified is ignored and remains untouched."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1352,"character":15}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}}}],"groups":[{"title":"Properties","kind":1024,"children":[1718,1719]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1341,"character":29}]},{"id":1720,"name":"Settings","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Specifies custom configurations for your Cloud Firestore instance. You must set these before invoking any other methods.","text":"Used with `firebase.firestore().settings()`.\n"},"children":[{"id":1722,"name":"cacheSizeBytes","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An approximate cache size threshold for the on-disk data. If the cache grows beyond this size, Firestore will start\nremoving data that hasn't been recently used. The size is not a guarantee that the cache will stay below that size,\nonly that if the cache exceeds the given size, cleanup will be attempted.","text":"To disable garbage collection and set an unlimited cache size, use `firebase.firestore.CACHE_SIZE_UNLIMITED`.\n"},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1373,"character":18}],"type":{"type":"intrinsic","name":"number"}},{"id":1723,"name":"host","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The hostname to connect to."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1378,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":1721,"name":"persistence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Enables or disables local persistent storage."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1364,"character":15}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1724,"name":"ssl","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Whether to use SSL when connecting."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1383,"character":7}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[1722,1723,1721,1724]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1360,"character":27}]},{"id":1725,"name":"SnapshotListenOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An options object that can be passed to `DocumentReference.onSnapshot()`, `Query.onSnapshot()` and `QuerySnapshot.docChanges()`\nto control which types of changes to include in the result set."},"children":[{"id":1726,"name":"includeMetadataChanges","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Include a change even if only the metadata of the query or of a document changed. Default is false."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1394,"character":26}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[1726]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1390,"character":40}]},{"id":1727,"name":"SnapshotMetadata","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Metadata about a snapshot, describing the state of the snapshot."},"children":[{"id":1728,"name":"fromCache","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"True if the snapshot includes local writes (`set()` or `update()` calls) that haven't been committed to the backend yet.\nIf your listener has opted into metadata updates (via `SnapshotListenOptions`) you will receive another snapshot with\n`fromCache` equal to false once the client has received up-to-date data from the backend."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1406,"character":13}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1729,"name":"hasPendingWrites","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"True if the snapshot contains the result of local writes (e.g. `set()` or `update()` calls) that have not yet been\ncommitted to the backend. If your listener has opted into metadata updates (via `SnapshotListenOptions`) you will\nreceive another snapshot with `hasPendingWrites` equal to false once the writes have been committed to the backend."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1413,"character":20}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1730,"name":"isEqual","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1731,"name":"isEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns true if this `SnapshotMetadata` is equal to the provided one."},"parameters":[{"id":1732,"name":"other","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The `SnapshotMetadata` to compare against.\n"},"type":{"type":"reference","name":"SnapshotMetadata","id":1727}}],"type":{"type":"intrinsic","name":"boolean"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1420,"character":11}]}],"groups":[{"title":"Properties","kind":1024,"children":[1728,1729]},{"title":"Methods","kind":2048,"children":[1730]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1400,"character":35}]},{"id":1808,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"`firebase.firestore.X`"},"children":[{"id":1809,"name":"Blob","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the `Blob` class."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1756,"character":8}],"type":{"type":"reference","name":"Blob","id":1294}},{"id":1814,"name":"CACHE_SIZE_UNLIMITED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Used to set the cache size to unlimited when passing to `cacheSizeBytes` in\n`firebase.firestore().settings()`."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1782,"character":24}],"type":{"type":"intrinsic","name":"number"}},{"id":1810,"name":"FieldPath","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the `FieldPath` class."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1761,"character":13}],"type":{"type":"reference","name":"FieldPath","id":1557}},{"id":1811,"name":"FieldValue","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the `FieldValue` class."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1766,"character":14}],"type":{"type":"reference","name":"FieldValue","id":1566}},{"id":1812,"name":"GeoPoint","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the `GeoPoint` class."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1771,"character":12}],"type":{"type":"reference","name":"GeoPoint","id":1583}},{"id":1813,"name":"Timestamp","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the `Timestamp` class."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1776,"character":13}],"type":{"type":"reference","name":"Timestamp","id":1733}},{"id":1815,"name":"setLogLevel","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1816,"name":"setLogLevel","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the verbosity of Cloud Firestore native device logs (debug, error, or silent).","text":"- `debug`: the most verbose logging level, primarily for debugging.\n- `error`: logs only error events.\n- `silent`: turn off logging.\n\n#### Example\n\n```js\nfirebase.firestore.setLogLevel('silent');\n```\n"},"parameters":[{"id":1817,"name":"logLevel","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The verbosity you set for activity and error logging.\n"},"type":{"type":"union","types":[{"type":"stringLiteral","value":"debug"},{"type":"stringLiteral","value":"error"},{"type":"stringLiteral","value":"silent"}]}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1799,"character":15}]}],"groups":[{"title":"Properties","kind":1024,"children":[1809,1814,1810,1811,1812,1813]},{"title":"Methods","kind":2048,"children":[1815]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1752,"character":26}]},{"id":1755,"name":"Transaction","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A reference to a transaction. The `Transaction` object passed to a transaction's updateFunction provides the methods to\nread and write data within the transaction context. See `Firestore.runTransaction()`.","text":"A transaction consists of any number of `get()` operations followed by any number of write operations such as set(),\n`update()`, or `delete()`. In the case of a concurrent edit, Cloud Firestore runs the entire transaction again. For example,\nif a transaction reads documents and another client modifies any of those documents, Cloud Firestore retries the transaction.\nThis feature ensures that the transaction runs on up-to-date and consistent data.\n\nTransactions never partially apply writes. All writes execute at the end of a successful transaction.\n\nWhen using transactions, note that:\n  - Read operations must come before write operations.\n  - A function calling a transaction (transaction function) might run more than once if a concurrent edit affects a document that the transaction reads.\n  - Transaction functions should not directly modify application state (return a value from the `updateFunction`).\n  - Transactions will fail when the client is offline.\n"},"children":[{"id":1756,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1757,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deletes the document referred to by the provided `DocumentReference`.","text":"#### Example\n\n```js\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nawait firebase.firestore().runTransaction((transaction) => {\n  return transaction.delete(docRef);\n});\n```\n"},"parameters":[{"id":1758,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be deleted.\n"},"type":{"type":"reference","name":"DocumentReference","id":1427}}],"type":{"type":"reference","name":"Transaction","id":1755}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1526,"character":10}]},{"id":1759,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1760,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Reads the document referenced by the provided `DocumentReference`.","text":"#### Example\n\n```js\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nawait firebase.firestore().runTransaction(async (transaction) => {\n  const snapshot = await transaction.get(docRef);\n   // use snapshot with transaction (see set() or update())\n   ...\n});\n```\n"},"parameters":[{"id":1761,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be read.\n"},"type":{"type":"reference","name":"DocumentReference","id":1427}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"DocumentSnapshot","id":1523}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1545,"character":7}]},{"id":1762,"name":"set","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1763,"name":"set","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes to the document referred to by the provided `DocumentReference`. If the document does not exist yet,\nit will be created. If you pass `SetOptions`, the provided data can be merged into the existing document.","text":"#### Example\n\n```js\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nawait firebase.firestore().runTransaction((transaction) => {\n  const snapshot = await transaction.get(docRef);\n  const snapshotData = snapshot.data();\n\n  return transaction.set(docRef, {\n    ...data,\n    age: 30, // new field\n  });\n});\n```\n"},"parameters":[{"id":1764,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be set."},"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1765,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object of the fields and values for the document."},"type":{"type":"reflection","declaration":{"id":1766,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1767,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1768,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1573,"character":11}]}}},{"id":1769,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An object to configure the set behavior.\n"},"type":{"type":"reference","name":"SetOptions","id":1717}}],"type":{"type":"reference","name":"Transaction","id":1755}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1571,"character":7}]},{"id":1770,"name":"update","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1771,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates fields in the document referred to by the provided `DocumentReference`. The update will fail if applied\nto a document that does not exist.","text":"#### Example\n\n```js\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nawait firebase.firestore().runTransaction((transaction) => {\n  const snapshot = await transaction.get(docRef);\n\n  return transaction.update(docRef, {\n    age: snapshot.data().age + 1,\n  });\n});\n```\n"},"parameters":[{"id":1772,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be updated."},"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1773,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.\n"},"type":{"type":"reflection","declaration":{"id":1774,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1775,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1776,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1598,"character":48}]}}}],"type":{"type":"reference","name":"Transaction","id":1755}},{"id":1777,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates fields in the document referred to by the provided DocumentReference. The update will fail if applied to\na document that does not exist.","text":"Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.\n\n#### Example\n\n```js\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nawait firebase.firestore().runTransaction((transaction) => {\n  const snapshot = await transaction.get(docRef);\n\n  return transaction.update(docRef, 'age', snapshot.data().age + 1);\n});\n```\n"},"parameters":[{"id":1778,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be updated."},"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1779,"name":"field","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The first field to update."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1780,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The first value."},"type":{"type":"intrinsic","name":"any"}},{"id":1781,"name":"moreFieldsAndValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"Additional key/value pairs.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"Transaction","id":1755}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1598,"character":10},{"fileName":"packages/firestore/lib/index.d.ts","line":1623,"character":10}]}],"groups":[{"title":"Methods","kind":2048,"children":[1756,1759,1762,1770]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1510,"character":30}]},{"id":1782,"name":"WriteBatch","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A write batch, used to perform multiple writes as a single atomic unit.","text":"A WriteBatch object can be acquired by calling `firestore.batch()`. It provides methods for adding\nwrites to the write batch. None of the writes will be committed (or visible locally) until\n`WriteBatch.commit()` is called.\n\nUnlike transactions, write batches are persisted offline and therefore are preferable when you don't need to\ncondition your writes on read data.\n"},"children":[{"id":1783,"name":"commit","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1784,"name":"commit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Commits all of the writes in this write batch as a single atomic unit.","text":"Returns a Promise resolved once all of the writes in the batch have been successfully written\nto the backend as an atomic unit. Note that it won't resolve while you're offline.\n\n#### Example\n\n```js\nconst batch = firebase.firestore().batch();\n\n// Perform batch operations...\n\nawait batch.commit();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1658,"character":10}]},{"id":1785,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1786,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deletes the document referred to by the provided `DocumentReference`.","text":"#### Example\n\n```js\nconst batch = firebase.firestore().batch();\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nbatch.delete(docRef);\n```\n"},"parameters":[{"id":1787,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be deleted.\n"},"type":{"type":"reference","name":"DocumentReference","id":1427}}],"type":{"type":"reference","name":"WriteBatch","id":1782}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1674,"character":10}]},{"id":1788,"name":"set","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1789,"name":"set","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes to the document referred to by the provided DocumentReference. If the document does\nnot exist yet, it will be created. If you pass SetOptions, the provided data can be merged\ninto the existing document.","text":"#### Example\n\n```js\nconst batch = firebase.firestore().batch();\nconst docRef = firebase.firestore().doc('users/dsmith');\n\nbatch.set(docRef, {\n  name: 'David Smith',\n  age: 25,\n});\n```\n"},"parameters":[{"id":1790,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be set."},"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1791,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object of the fields and values for the document."},"type":{"type":"reflection","declaration":{"id":1792,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1793,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1794,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1699,"character":11}]}}},{"id":1795,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An object to configure the set behavior.\n"},"type":{"type":"reference","name":"SetOptions","id":1717}}],"type":{"type":"reference","name":"WriteBatch","id":1782}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1697,"character":7}]},{"id":1796,"name":"update","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1797,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates fields in the document referred to by the provided DocumentReference. The update will fail if applied to a document that does not exist.","text":"#### Example\n\n```js\nconst batch = firebase.firestore().batch();\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nbatch.update(docRef, {\n  city: 'SF',\n});\n```\n"},"parameters":[{"id":1798,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be updated."},"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1799,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.\n"},"type":{"type":"reflection","declaration":{"id":1800,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1801,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1802,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"value","id":282}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1720,"character":48}]}}}],"type":{"type":"reference","name":"WriteBatch","id":1782}},{"id":1803,"name":"update","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates fields in the document referred to by this DocumentReference. The update will fail if applied to a document that does not exist.","text":"Nested fields can be update by providing dot-separated field path strings or by providing FieldPath objects.\n\n#### Example\n\n```js\nconst batch = firebase.firestore().batch();\nconst docRef = firebase.firestore().doc('users/alovelace');\n\nbatch.update(docRef, 'city', 'SF', 'age', 31);\n```\n"},"parameters":[{"id":1804,"name":"documentRef","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A reference to the document to be updated."},"type":{"type":"reference","name":"DocumentReference","id":1427}},{"id":1805,"name":"field","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The first field to update."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"FieldPath","id":1557}]}},{"id":1806,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The first value."},"type":{"type":"intrinsic","name":"any"}},{"id":1807,"name":"moreFieldAndValues","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"Additional key value pairs.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","name":"WriteBatch","id":1782}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1720,"character":10},{"fileName":"packages/firestore/lib/index.d.ts","line":1741,"character":10}]}],"groups":[{"title":"Methods","kind":2048,"children":[1783,1785,1788,1796]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1641,"character":29}]},{"id":1844,"name":"DocumentChangeType","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"The type of a DocumentChange may be 'added', 'removed', or 'modified'."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":176,"character":32}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"added"},{"type":"stringLiteral","value":"removed"},{"type":"stringLiteral","value":"modified"}]}},{"id":1845,"name":"DocumentFieldType","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"The types for a DocumentSnapshot field that are supported by Firestore."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":181,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"boolean"},{"type":"reflection","declaration":{"id":1846,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1847,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1848,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"DocumentFieldType","id":1845}}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":185,"character":5}]}},{"type":"array","elementType":{"type":"reference","name":"DocumentFieldType","id":1845}},{"type":"intrinsic","name":"null"},{"type":"reference","name":"Timestamp","id":1733},{"type":"reference","name":"GeoPoint","id":1583},{"type":"reference","name":"Blob","id":1294},{"type":"reference","name":"FieldPath","id":1557},{"type":"reference","name":"FieldValue","id":1566},{"type":"reference","name":"DocumentReference","id":1427},{"type":"reference","name":"CollectionReference","id":1308}]}},{"id":1849,"name":"WhereFilterOp","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"Filter conditions in a `Query.where()` clause are specified using the strings '<', '<=', '==', '>=', '>', 'array-contains', 'array-contains-any' or 'in'."},"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":1224,"character":27}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"<"},{"type":"stringLiteral","value":"<="},{"type":"stringLiteral","value":"=="},{"type":"stringLiteral","value":">"},{"type":"stringLiteral","value":">="},{"type":"stringLiteral","value":"array-contains"},{"type":"stringLiteral","value":"array-contains-any"},{"type":"stringLiteral","value":"in"}]}}],"groups":[{"title":"Classes","kind":128,"children":[1294,1557,1566,1583,1818,1733]},{"title":"Interfaces","kind":256,"children":[1308,1422,1427,1523,1593,1595,1540,1697,1717,1720,1725,1727,1808,1755,1782]},{"title":"Type aliases","kind":4194304,"children":[1844,1845,1849]}],"sources":[{"fileName":"packages/firestore/lib/index.d.ts","line":50,"character":39}]},{"id":1857,"name":"FirebaseFunctionsTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Cloud Functions package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `functions` package:\n\n```js\nimport { firebase } from '@react-native-firebase/functions';\n\n// firebase.functions().X\n```\n\n#### Example 2\n\nUsing the default export from the `functions` package:\n\n```js\nimport functions from '@react-native-firebase/functions';\n\n// functions().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/functions';\n\n// firebase.functions().X\n```\n","tags":[{"tag":"firebase","text":"functions\n"}]},"children":[{"id":1890,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Cloud Functions service is available for the default app, a given app or a specified region.","text":"> The default functions region for all apps is `us-central1`.\n\n#### Example 1\n\nGet the functions instance for the **default app**:\n\n```js\nconst functionsForDefaultApp = firebase.functions();\n```\n\n#### Example 2\n\nGet the functions instance for a **secondary app**:\n\n```js\nconst otherApp = firebase.app('otherApp');\nconst functionsForOtherApp = firebase.functions(otherApp);\n```\n\n#### Example 3\n\nGet the functions instance for a **specific functions region**:\n\n```js\nconst defaultApp = firebase.app();\nconst functionsForRegion = defaultApp.functions('europe-west1');\n\nconst otherApp = firebase.app('otherApp');\nconst functionsForOtherAppRegion = otherApp.functions('europe-west1');\n```\n\n"},"children":[{"id":1897,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":1891,"name":"httpsCallable","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1892,"name":"httpsCallable","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets an `HttpsCallable` instance that refers to the function with the given\nname.","text":"#### Example\n\n```js\nconst instance = firebase.functions().httpsCallable('order');\n\ntry {\n const response = await instance({\n   id: '12345',\n });\n} catch (e) {\n console.error(e);\n}\n```\n","returns":"The `HttpsCallable` instance.\n"},"parameters":[{"id":1893,"name":"name","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The name of the https callable function."},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"HttpsCallable","id":1860}}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":315,"character":17}]},{"id":1894,"name":"useFunctionsEmulator","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1895,"name":"useFunctionsEmulator","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Changes this instance to point to a Cloud Functions emulator running\nlocally.","text":"See https://firebase.google.com/docs/functions/local-emulator\n\n#### Example\n\n```js\nif (__DEV__) {\n  firebase.functions().useFunctionsEmulator('http://10.0.0.8:1337');\n}\n```\n"},"parameters":[{"id":1896,"name":"origin","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The origin string of the local emulator started via firebase tools\n\"http://10.0.0.8:1337\".\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":334,"character":24}]}],"groups":[{"title":"Properties","kind":1024,"children":[1897]},{"title":"Methods","kind":2048,"children":[1891,1894]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":293,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":1860,"name":"HttpsCallable","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An HttpsCallable is a reference to a \"callable\" http trigger in\nGoogle Cloud Functions.","text":"#### Example\n\n```js\n// Create a HttpsCallable instance\nconst instance = firebase.functions().httpsCallable('order');\n\ntry {\n const response = await instance({\n   id: '12345',\n });\n} catch (e) {\n console.error(e);\n}\n```\n"},"signatures":[{"id":1861,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"An HttpsCallable is a reference to a \"callable\" http trigger in\nGoogle Cloud Functions.","text":"#### Example\n\n```js\n// Create a HttpsCallable instance\nconst instance = firebase.functions().httpsCallable('order');\n\ntry {\n const response = await instance({\n   id: '12345',\n });\n} catch (e) {\n console.error(e);\n}\n```\n"},"parameters":[{"id":1862,"name":"data","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"HttpsCallableResult","id":1858}]}}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":143,"character":32}]},{"id":1858,"name":"HttpsCallableResult","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An HttpsCallableResult wraps a single result from a function call."},"children":[{"id":1859,"name":"data","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":121,"character":17}],"type":{"type":"intrinsic","name":"any"}}],"groups":[{"title":"Properties","kind":1024,"children":[1859]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":120,"character":38}]},{"id":1863,"name":"HttpsError","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An HttpsError wraps a single error from a function call.","text":"#### Example\n\n```js\ntry {\n await firebase.functions().httpsCallable('order')();\n} catch (httpsError) {\n  console.log('Message', httpsError.message);\n\n  // Check code\n  if (httpsError.code === firebase.functions.HttpsErrorCode.NOT_FOUND) {\n    console.error('Functions endpoint \"order\" not found');\n  }\n}\n```\n"},"children":[{"id":1869,"name":"Error","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":984,"character":17}],"type":{"type":"reference","name":"ErrorConstructor"}},{"id":1864,"name":"code","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A standard error code that will be returned to the client. This also\ndetermines the HTTP status code of the response, as defined in code.proto.","text":"#### Example\n\n```js\ntry {\n await firebase.functions().httpsCallable('order')();\n} catch (httpsError) {\n  console.error(httpsError.code);\n}\n```\n"},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":180,"character":17}],"type":{"type":"reference","name":"FunctionsErrorCode","id":1898}},{"id":1865,"name":"details","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Extra data to be converted to JSON and included in the error response.","text":"```js\ntry {\n await firebase.functions().httpsCallable('order')();\n} catch (httpsError) {\n  if (httpsError.details) {\n    console.error(httpsError.details);\n  }\n}\n```\n"},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":194,"character":20}],"type":{"type":"intrinsic","name":"any"}},{"id":1867,"name":"message","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":974,"character":11}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"Error.message"}},{"id":1866,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":973,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"Error.name"}},{"id":1868,"name":"stack","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":975,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]},"inheritedFrom":{"type":"reference","name":"Error.stack"}}],"groups":[{"title":"Properties","kind":1024,"children":[1869,1864,1865,1867,1866,1868]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":165,"character":29}],"extendedTypes":[{"type":"reference","name":"Error"}]},{"id":1870,"name":"HttpsErrorCode","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The HttpsErrorCode interface provides access to all FunctionsErrorCode\ntype aliases.","text":"#### Example\n\n```js\ntry {\n await firebase.functions().httpsCallable('order')();\n} catch (httpsError) {\n switch(httpsError.code) {\n   case firebase.functions.HttpsErrorCode.NOT_FOUND:\n     console.error('Functions endpoint not found');\n     break;\n   case firebase.functions.HttpsErrorCode.CANCELLED:\n     console.error('The operation was cancelled');\n     break;\n   default:\n     console.error('An error occurred');\n     break;\n }\n}\n```\n"},"children":[{"id":1882,"name":"ABORTED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":233,"character":11}],"type":{"type":"stringLiteral","value":"aborted"}},{"id":1877,"name":"ALREADY_EXISTS","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":228,"character":18}],"type":{"type":"stringLiteral","value":"already-exists"}},{"id":1872,"name":"CANCELLED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":223,"character":13}],"type":{"type":"stringLiteral","value":"cancelled"}},{"id":1887,"name":"DATA_LOSS","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":238,"character":13}],"type":{"type":"stringLiteral","value":"data-loss"}},{"id":1875,"name":"DEADLINE_EXCEEDED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":226,"character":21}],"type":{"type":"stringLiteral","value":"deadline-exceeded"}},{"id":1881,"name":"FAILED_PRECONDITION","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":232,"character":23}],"type":{"type":"stringLiteral","value":"failed-precondition"}},{"id":1885,"name":"INTERNAL","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":236,"character":12}],"type":{"type":"stringLiteral","value":"internal"}},{"id":1874,"name":"INVALID_ARGUMENT","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":225,"character":20}],"type":{"type":"stringLiteral","value":"invalid-argument"}},{"id":1876,"name":"NOT_FOUND","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":227,"character":13}],"type":{"type":"stringLiteral","value":"not-found"}},{"id":1871,"name":"OK","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":222,"character":6}],"type":{"type":"stringLiteral","value":"ok"}},{"id":1883,"name":"OUT_OF_RANGE","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":234,"character":16}],"type":{"type":"stringLiteral","value":"out-of-range"}},{"id":1878,"name":"PERMISSION_DENIED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":229,"character":21}],"type":{"type":"stringLiteral","value":"permission-denied"}},{"id":1880,"name":"RESOURCE_EXHAUSTED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":231,"character":22}],"type":{"type":"stringLiteral","value":"resource-exhausted"}},{"id":1879,"name":"UNAUTHENTICATED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":230,"character":19}],"type":{"type":"stringLiteral","value":"unauthenticated"}},{"id":1886,"name":"UNAVAILABLE","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":237,"character":15}],"type":{"type":"stringLiteral","value":"unavailable"}},{"id":1884,"name":"UNIMPLEMENTED","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":235,"character":17}],"type":{"type":"stringLiteral","value":"unimplemented"}},{"id":1873,"name":"UNKNOWN","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":224,"character":11}],"type":{"type":"stringLiteral","value":"unknown"}}],"groups":[{"title":"Properties","kind":1024,"children":[1882,1877,1872,1887,1875,1881,1885,1874,1876,1871,1883,1878,1880,1879,1886,1884,1873]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":221,"character":33}]},{"id":1888,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"firebase.functions.X"},"children":[{"id":1889,"name":"HttpsErrorCode","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Uppercase + underscored variables of {@link functions.FunctionsErrorCode}","text":"#### Example\n\n```js\nfirebase.functions.HttpsErrorCode.OK;\nfirebase.functions.HttpsErrorCode.NOT_FOUND;\n```\n"},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":255,"character":18}],"type":{"type":"reference","name":"HttpsErrorCode","id":1870}}],"groups":[{"title":"Properties","kind":1024,"children":[1889]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":244,"character":26}]},{"id":1898,"name":"FunctionsErrorCode","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":98,"character":32}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"ok"},{"type":"stringLiteral","value":"cancelled"},{"type":"stringLiteral","value":"unknown"},{"type":"stringLiteral","value":"invalid-argument"},{"type":"stringLiteral","value":"deadline-exceeded"},{"type":"stringLiteral","value":"not-found"},{"type":"stringLiteral","value":"already-exists"},{"type":"stringLiteral","value":"permission-denied"},{"type":"stringLiteral","value":"resource-exhausted"},{"type":"stringLiteral","value":"failed-precondition"},{"type":"stringLiteral","value":"aborted"},{"type":"stringLiteral","value":"out-of-range"},{"type":"stringLiteral","value":"unimplemented"},{"type":"stringLiteral","value":"internal"},{"type":"stringLiteral","value":"unavailable"},{"type":"stringLiteral","value":"data-loss"},{"type":"stringLiteral","value":"unauthenticated"}]}}],"groups":[{"title":"Classes","kind":128,"children":[1890]},{"title":"Interfaces","kind":256,"children":[1860,1858,1863,1870,1888]},{"title":"Type aliases","kind":4194304,"children":[1898]}],"sources":[{"fileName":"packages/functions/lib/index.d.ts","line":56,"character":39}]},{"id":1907,"name":"FirebaseIidTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Instance ID package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `iid` package:\n\n```js\nimport { firebase } from '@react-native-firebase/iid';\n\n// firebase.iid().X\n```\n\n#### Example 2\n\nUsing the default export from the `iid` package:\n\n```js\nimport iid from '@react-native-firebase/iid';\n\n// iid().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/iid';\n\n// firebase.iid().X\n```\n","tags":[{"tag":"firebase","text":"iid\n"}]},"children":[{"id":1909,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Instance ID service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Instance ID service for the default app:\n\n```js\nconst defaultAppIid = firebase.iid();\n```\n"},"children":[{"id":1922,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":1912,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1913,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Delete the Instance ID and all data associated with it. This stops the periodic sending of data to the Firebase\nbackend that was started when the Instance ID was generated.","text":"A new Instance ID is asynchronously generated unless auto initialisation is turned off.\n\n#### Example\n\n```js\nawait firebase.iid().delete();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":101,"character":10}]},{"id":1918,"name":"deleteToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1919,"name":"deleteToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Revokes access to a scope for an entity previously authorized by `getToken()`.","text":"#### Example\n\n```js\nawait firebase.iid().deleteToken(firebase.app().options.storageBucket, '*');\n```\n"},"parameters":[{"id":1920,"name":"authorizedEntity","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Entity authorized by the token. Defaults to the apps' `messagingSenderId` option."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1921,"name":"scope","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Action authorized for authorizedEntity. Defaults to '*'.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":129,"character":15}]},{"id":1910,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1911,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a identifier that uniquely identifies the app instance.","text":"Once an Instance ID is generated, Firebase periodically sends information about the application\nand the device it's running on to the Firebase backend. To stop this, see `delete()`.\n\n#### Example\n\n```js\nconst id = firebase.iid().get();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":87,"character":7}]},{"id":1914,"name":"getToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1915,"name":"getToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a token that authorizes an Entity to perform an action on behalf of the application.","text":"#### Example\n\n```js\nconst token = await firebase.iid().getToken(firebase.app().options.storageBucket, '*');\n```\n"},"parameters":[{"id":1916,"name":"authorizedEntity","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Entity authorized by the token. Defaults to the apps `messagingSenderId` option."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1917,"name":"scope","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Action authorized for authorizedEntity. Defaults to '*'.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":115,"character":12}]}],"groups":[{"title":"Properties","kind":1024,"children":[1922]},{"title":"Methods","kind":2048,"children":[1912,1918,1910,1914]}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":74,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":1908,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":59,"character":26}]}],"groups":[{"title":"Classes","kind":128,"children":[1909]},{"title":"Interfaces","kind":256,"children":[1908]}],"sources":[{"fileName":"packages/iid/lib/index.d.ts","line":56,"character":33}]},{"id":1930,"name":"FirebaseInAppMessagingTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase In-App Messaging package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `inAppMessaging` package:\n\n```js\nimport { firebase } from '@react-native-firebase/in-app-messaging';\n\n// firebase.inAppMessaging().X\n```\n\n#### Example 2\n\nUsing the default export from the `in-app-messaging` package:\n\n```js\nimport inAppMessaging from '@react-native-firebase/in-app-messaging';\n\n// inAppMessaging().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/in-app-messaging';\n\n// firebase.inAppMessaging().X\n```\n","tags":[{"tag":"firebase","text":"in-app-messaging\n"}]},"children":[{"id":1932,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase In-App Messaging service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the  In-App Messaging service for the default app:\n\n```js\nconst defaultAppInAppMessaging = firebase.inAppMessaging();\n```\n"},"children":[{"id":1941,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":1937,"name":"isAutomaticDataCollectionEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Determines whether automatic data collection is enabled or not.","text":"#### Example\n\n```js\nconst isDataCollectionEnabled = firebase.inAppMessaging().isAutomaticDataCollectionEnabled;\n```\n"},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":112,"character":36}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1933,"name":"isMessagesDisplaySuppressed","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Determines whether messages are suppressed or not.","text":"#### Example\n\n```js\nconst isSuppressed = firebase.inAppMessaging().isMessagesDisplaySuppressed;\n```\n"},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":84,"character":31}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1938,"name":"setAutomaticDataCollectionEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1939,"name":"setAutomaticDataCollectionEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Enable or disable automatic data collection for Firebase In-App Messaging.","text":"When enabled, generates a registration token on app startup if there is no valid one and generates a new token\nwhen it is deleted (which prevents `deleteInstanceId()` from stopping the periodic sending of data).\n\nThis setting is persisted across app restarts and overrides the setting specified in your manifest/plist file.\n\n#### Example\n\n```js\n// Disable data collection\nfirebase.inAppMessaging().setAutomaticDataCollectionEnabled(false);\n```\n"},"parameters":[{"id":1940,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Whether automatic data collection is enabled.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":131,"character":37}]},{"id":1934,"name":"setMessagesDisplaySuppressed","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":1935,"name":"setMessagesDisplaySuppressed","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Enable or disable suppression of Firebase In App Messaging messages.","text":"When enabled, no in app messages will be rendered until either you disable suppression, or the app restarts.\nThis state is not persisted between app restarts.\n\n#### Example\n\n```js\n// Suppress messages\nawait firebase.inAppMessaging().setMessagesDisplaySuppressed(true);\n```\n"},"parameters":[{"id":1936,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Whether messages should be suppressed.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":101,"character":32}]}],"groups":[{"title":"Properties","kind":1024,"children":[1941,1937,1933]},{"title":"Methods","kind":2048,"children":[1938,1934]}],"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":74,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":1931,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":59,"character":26}]}],"groups":[{"title":"Classes","kind":128,"children":[1932]},{"title":"Interfaces","kind":256,"children":[1931]}],"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":56,"character":44}]},{"id":2124,"name":"FirebaseLanguageTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase ML Kit package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `naturalLanguage` package:\n\n```js\nimport { firebase } from '@react-native-firebase/ml-natural-language';\n\n// firebase.naturalLanguage().X\n```\n\n#### Example 2\n\nUsing the default export from the `naturalLanguage` package:\n\n```js\nimport naturalLanguage from '@react-native-firebase/ml-natural-language';\n\n// naturalLanguage().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/ml-natural-language';\n\n// firebase.naturalLanguage().X\n```\n","tags":[{"tag":"firebase","text":"ml-natural-language\n"}]},"children":[{"id":2133,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase ML Kit service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the ML Kit service for the default app:\n\n```js\nconst defaultAppMLKit = firebase.naturalLanguage();\n```\n"},"children":[{"id":2145,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":2134,"name":"identifyLanguage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2135,"name":"identifyLanguage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Identifies the main language for the given text.","text":"Returns a promise that resolves with a [BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag) of the detected language.\n\nIf the language was undetected or unknown the code returned is `und`.\n\n#### Example\n\n```js\nconst language = await firebase.naturalLanguage().identifyLanguage('Hello there. General Kenobi.');\nconsole.warn(language); // en\n\nconst unknownLanguage = await firebase.naturalLanguage().identifyLanguage('foo bar baz', { confidenceThreshold: 0.9 });\nconsole.warn(language); // und\n```\n"},"parameters":[{"id":2136,"name":"text","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The input text to use for identifying the language. Inputs longer than 200 characters are truncated to 200 characters, as longer input does not improve the detection accuracy."},"type":{"type":"intrinsic","name":"string"}},{"id":2137,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"See `LanguageIdentificationOptions`.\n"},"type":{"type":"reference","name":"LanguageIdentificationOptions","id":2126}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":153,"character":20}]},{"id":2138,"name":"identifyPossibleLanguages","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2139,"name":"identifyPossibleLanguages","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Identifies possible languages for the given text.","text":"#### Example\n\n```js\nconst identifiedLanguages = firebase.naturalLanguage().identifyPossibleLanguages('hello world');\nconsole.warn(identifiedLanguages[0].language); // en\n```\n"},"parameters":[{"id":2140,"name":"text","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The input text to use for identifying the language. Inputs longer than 200 characters are truncated to 200 characters, as longer input does not improve the detection accuracy."},"type":{"type":"intrinsic","name":"string"}},{"id":2141,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"See `LanguageIdentificationOptions`.\n"},"type":{"type":"reference","name":"LanguageIdentificationOptions","id":2126}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"IdentifiedLanguage","id":2128}}]}}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":168,"character":29}]},{"id":2142,"name":"suggestReplies","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2143,"name":"suggestReplies","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns suggested replies for a conversation.","text":"#### Example\n\n```js\nconst replies = await firebase.naturalLanguage().suggestReplies([\n  { text: \"Hey, long time no speak!\", },\n  { text: 'I know right, it has been a while..', userId: 'xxxx', isLocalUser: false },\n  { text: 'We should catchup some time!', },\n  { text: 'Definitely, how about we go for lunch this week?', userId: 'xxxx', isLocalUser: false },\n]);\n```\n"},"parameters":[{"id":2144,"name":"messages","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An array of `TextMessage` interfaces.\n"},"type":{"type":"array","elementType":{"type":"reference","name":"TextMessage","id":2146}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"SuggestedReply","id":2131}}]}}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":189,"character":18}]}],"groups":[{"title":"Properties","kind":1024,"children":[2145]},{"title":"Methods","kind":2048,"children":[2134,2138,2142]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":132,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":2128,"name":"IdentifiedLanguage","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An identified language for the given input text. Returned as an Array of IdentifiedLanguage from\n`identifyPossibleLanguages`."},"children":[{"id":2130,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence score of the language. A float value between 0 and 1."},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":89,"character":14}],"type":{"type":"intrinsic","name":"number"}},{"id":2129,"name":"language","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The [BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag) for the language, e.g. 'en'."},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":84,"character":12}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2130,2129]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":80,"character":37}]},{"id":2126,"name":"LanguageIdentificationOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An interface representing the language identification options to be used with the\n`identifyLanguage` and `identifyPossibleLanguages` methods."},"children":[{"id":2127,"name":"confidenceThreshold","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The confidence threshold for language identification. The identified languages will have a\nconfidence higher or equal to the confidence threshold. The value should be between 0 and 1, e.g. 0.5.","text":"If no value is set, a default value is used instead.\n\n"},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":73,"character":23}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2127]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":65,"character":48}]},{"id":2125,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":59,"character":26}]},{"id":2131,"name":"SuggestedReply","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An interface representing a suggested reply, an array of these are returned from `suggestReplies`.","text":"#### Example\n\n```js\nconst replies = await firebase.naturalLanguage().suggestReplies([\n  { text: \"Hey, long time no speak!\", },\n  { text: 'I know right, it has been a while..', userId: 'xxxx', isLocalUser: false },\n  { text: 'We should catchup some time!', },\n  { text: 'Definitely, how about we go for lunch this week?', userId: 'xxxx', isLocalUser: false },\n]);\n\nreplies.forEach(reply => {\n  console.log(reply.text);\n});\n\n```\n\n"},"children":[{"id":2132,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The smart reply text."},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":116,"character":8}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2132]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":112,"character":33}]},{"id":2146,"name":"TextMessage","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A `TextMessage` interface provided to `suggestReplies()`."},"children":[{"id":2148,"name":"isLocalUser","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Whether the message is a local user. If false, a `userId` must be provided for the message.","text":"Defaults to true.\n"},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":208,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2147,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The message text.","text":"This is required and must not be an empty string.\n"},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":201,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":2150,"name":"timestamp","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The timestamp of the message in milliseconds.","text":"Defaults to now (`Date.now()`).\n"},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":222,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":2149,"name":"userId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A user ID of a remote user.","text":"Used to help better identify users to provide more accurate replies.\n"},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":215,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2148,2147,2150,2149]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":195,"character":30}]}],"groups":[{"title":"Classes","kind":128,"children":[2133]},{"title":"Interfaces","kind":256,"children":[2128,2126,2125,2131,2146]}],"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":56,"character":38}]},{"id":1950,"name":"FirebaseMessagingTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Messaging package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `messaging` package:\n\n```js\nimport { firebase } from '@react-native-firebase/messaging';\n\n// firebase.messaging().X\n```\n\n#### Example 2\n\nUsing the default export from the `messaging` package:\n\n```js\nimport messaging from '@react-native-firebase/messaging';\n\n// messaging().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/messaging';\n\n// firebase.messaging().X\n```\n","tags":[{"tag":"firebase","text":"messaging\n"}]},"children":[{"id":2012,"name":"AuthorizationStatus","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"An enum representing the notification authorization status for this app on the device.","text":"Value is truthy if authorized, compare against an exact status (e.g. iOS PROVISIONAL) for a more\ngranular status.\n\nExample:\n\n```js\nfirebase.messaging.AuthorizationStatus.NOT_DETERMINED;\n```\n"},"children":[{"id":2015,"name":"AUTHORIZED","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The app is authorized to create notifications."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":424,"character":14}],"defaultValue":"1"},{"id":2014,"name":"DENIED","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The app is not authorized to create notifications."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":419,"character":10}],"defaultValue":"0"},{"id":2013,"name":"NOT_DETERMINED","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The app user has not yet chosen whether to allow the application to create notifications. Usually\nthis status is returned prior to the first call of `requestPermission`.","tags":[{"tag":"platform","text":"ios iOS\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":414,"character":18}],"defaultValue":" -1"},{"id":2016,"name":"PROVISIONAL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The app is currently authorized to post non-interrupting user notifications","tags":[{"tag":"platform","text":"ios iOS >= 12\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":430,"character":15}],"defaultValue":"2"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2015,2014,2013,2016]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":407,"character":33}]},{"id":1995,"name":"NotificationAndroidPriority","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The enum representing a notification priority.","text":"Note; on devices which have channel support (Android 8.0 (API level 26) +),\nthis value will be ignored. Instead, the channel \"importance\" level is used.\n\nExample:\n\n```js\nfirebase.messaging.NotificationAndroidPriority.PRIORITY_MIN;\n```\n"},"children":[{"id":1998,"name":"PRIORITY_DEFAULT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"When a notification is received, the device smallIcon will appear in the notification shade.\nWhen the user pulls down the notification shade, the content of the notification will be shown\nin it's expanded state."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":302,"character":20}],"defaultValue":"0"},{"id":1999,"name":"PRIORITY_HIGH","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Notifications will appear on-top of applications, allowing direct interaction without pulling\nown the notification shade. This level is used for urgent notifications, such as\nincoming phone calls, messages etc, which require immediate attention."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":309,"character":17}],"defaultValue":"1"},{"id":1997,"name":"PRIORITY_LOW","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The application small icon will show in the device status bar, however the notification will\nnot alert the user (no sound or vibration). The notification will show in it's expanded state\nwhen the notification shade is pulled down."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":295,"character":16}],"defaultValue":" -1"},{"id":2000,"name":"PRIORITY_MAX","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The priority highest level a notification can be set at."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":314,"character":16}],"defaultValue":"2"},{"id":1996,"name":"PRIORITY_MIN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The application small icon will not show up in the status bar, or alert the user. The notification\nwill be in a collapsed state in the notification shade and placed at the bottom of the list."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":288,"character":16}],"defaultValue":" -2"}],"groups":[{"title":"Enumeration members","kind":16,"children":[1998,1999,1997,2000,1996]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":283,"character":41}]},{"id":2001,"name":"NotificationAndroidVisibility","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The enum representing the visibility of a notification.","text":"Example:\n\n```js\nfirebase.messaging.NotificationAndroidVisibility.VISIBILITY_SECRET;\n```\n"},"children":[{"id":2003,"name":"VISIBILITY_PRIVATE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Show this notification on all lock-screens, but conceal sensitive or private information on secure lock-screens."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":335,"character":22}],"defaultValue":"0"},{"id":2004,"name":"VISIBILITY_PUBLIC","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Show this notification in its entirety on all lock-screens."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":340,"character":21}],"defaultValue":"1"},{"id":2002,"name":"VISIBILITY_SECRET","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Do not reveal any part of this notification on a secure lock-screen."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":330,"character":21}],"defaultValue":" -1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2003,2004,2002]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":326,"character":43}]},{"id":2020,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Messaging service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Messaging service for the default app:\n\n```js\nconst defaultAppMessaging = firebase.messaging();\n```\n"},"children":[{"id":2112,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":2021,"name":"isAutoInitEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns whether messaging auto initialization is enabled or disabled for the device.","text":"#### Example\n\n```js\nconst isAutoInitEnabled = firebase.messaging().isAutoInitEnabled;\n```\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":479,"character":21}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2065,"name":"isDeviceRegisteredForRemoteMessages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a boolean value whether the user has registered for remote notifications via\n`registerDeviceForRemoteMessages()`.","text":"> You can safely access this property on Android without platform checks. Android returns `true` only.\n\n#### Example\n\n```js\nconst isRegisteredForRemoteNotifications = firebase.messaging().isRegisteredForRemoteNotifications;\n```\n","tags":[{"tag":"platform","text":"ios\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":720,"character":39}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2064,"name":"isRegisteredForRemoteNotifications","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Deprecated. See `isDeviceRegisteredForRemoteMessages` instead.","tags":[{"tag":"platform","text":"ios"},{"tag":"deprecated","text":"See isDeviceRegisteredForRemoteMessages\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":704,"character":38}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2031,"name":"deleteToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2032,"name":"deleteToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes access to an FCM token previously authorized by it's scope. Messages sent by the server\nto this token will fail.","text":"#### Example\n\n```js\nawait firebase.messaging().deleteToken();\n```\n"},"parameters":[{"id":2033,"name":"authorizedEntity","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The messaging sender ID. In most cases this will be the current default app."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2034,"name":"scope","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The scope to assign when token will be deleted.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]},"defaultValue":"\"FCM\""}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":576,"character":15}]},{"id":2070,"name":"getAPNSToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2071,"name":"getAPNSToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"On iOS, it is possible to get the users APNS token. This may be required if you want to send messages to your\niOS devices without using the FCM service.","text":"> You can safely call this method on Android without platform checks. It's a no-op on Android and will promise resolve `null`.\n\n#### Example\n\n```js\nconst apnsToken = await firebase.messaging().getAPNSToken();\n\nif (apnsToken) {\n  console.log('User APNS Token:', apnsToken);\n}\n```\n","tags":[{"tag":"ios","text":"\n"}]},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":765,"character":16}]},{"id":2025,"name":"getInitialNotification","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2026,"name":"getInitialNotification","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"When a notification from FCM has triggered the application to open from a quit state,\nthis method will return a `RemoteMessage` containing the notification data, or `null` if\nthe app was opened via another method.","text":"See `onNotificationOpenedApp` to subscribe to when the notification is opened when the app\nis in a background state.\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"union","types":[{"type":"reference","name":"RemoteMessage","id":1955},{"type":"intrinsic","name":"null"}]}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":510,"character":26}]},{"id":2027,"name":"getToken","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2028,"name":"getToken","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an FCM token for this device. Optionally you can specify a custom authorized entity\nor scope to tailor tokens to your own use-case.","text":"It is recommended you call this method on app start and update your backend with the new token.\n\nOn iOS you'll need to register for remote notifications before calling this method, you can do\nthis by calling `registerDeviceForRemoteMessages` or `requestPermission` as part of your app\nstartup. If you have not registered and you call this method you will receive an 'unregistered'\nerror code.\n\n#### Example - Default token\n\n```js\nawait firebase.messaging().registerDeviceForRemoteMessages();\nconst fcmToken = await firebase.messaging().getToken();\n\n// Update backend (e.g. Firestore) with our scoped token for the user\nconst uid = firebase.auth().currentUser.uid;\nawait firebase.firestore().doc(`users/${uid}`)\n  .update({\n    fcmTokens: firebase.firestore.FieldValues.arrayUnion(fcmToken),\n  });\n```\n\n#### Example - Scoped Token\n\nThe below example creates a new token for a specific notification scope (in this case, ALARM).\nYour server can specifically send messages to 'ALARM' tokens. By default, all notification scopes\nwill be received.\n\n```js\n// Get a token for 'ALARM' notifications\nconst alarmFcmToken = await firebase.messaging().getToken(\n  firebase.app().options.messagingSenderId, // default to this app\n  'ALARM', // defaults to 'FCM'\n);\n\n// Update backend (e.g. Firestore) with our scoped token for the user\nconst uid = firebase.auth().currentUser.uid;\nawait firebase.firestore().doc(`users/${uid}`)\n  .update({\n    alarmFcmTokens: firebase.firestore.FieldValues.arrayUnion(alarmFcmToken),\n  });\n```\n"},"parameters":[{"id":2029,"name":"authorizedEntity","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The messaging sender ID. In most cases this will be the current default app."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2030,"name":"scope","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The scope to assign a token, which the sever can use to target messages at.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]},"defaultValue":"\"FCM\""}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":561,"character":12}]},{"id":2072,"name":"hasPermission","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2073,"name":"hasPermission","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a `AuthorizationStatus` as to whether the user has messaging permission for this app.","text":"#### Example\n\n```js\nconst authStatus = await firebase.messaging().hasPermission();\nif (authStatus === firebase.messaging.AuthorizationStatus.AUTHORIZED) {\n  // yay\n}\n\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"AuthorizationStatus","id":2012}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":780,"character":17}]},{"id":2074,"name":"onDeletedMessages","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2075,"name":"onDeletedMessages","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Called when the FCM server deletes pending messages. This may be due to:","text":"1. Too many messages stored on the FCM server. This can occur when an app's servers send a bunch\nof non-collapsible messages to FCM servers while the device is offline.\n\n2. The device hasn't connected in a long time and the app server has recently (within the last\n4 weeks) sent a message to the app on that device.\n\nIt is recommended that the app do a full sync with the server after receiving this call (e.g.\nrequesting all user messages from the database).\n\nReturns an unsubscribe function to stop listening for deleted messages.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.messaging().onDeletedMessages(() => {\n  // Perform a full app re-sync\n});\n\n// Unsubscribe from deleted messages events\nunsubscribe();\n```\n"},"parameters":[{"id":2076,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Called when the FCM deletes pending messages.\n"},"type":{"type":"reflection","declaration":{"id":2077,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2078,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":809,"character":31}]}}}],"type":{"type":"reflection","declaration":{"id":2079,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2080,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":809,"character":44}]}}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":809,"character":21}]},{"id":2035,"name":"onMessage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2036,"name":"onMessage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"When any FCM payload is received, the listener callback is called with a `RemoteMessage`.","text":"Returns an unsubscribe function to stop listening for new messages.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.messaging().onMessage(async (remoteMessage) => {\n  console.log('FCM Message Data:', remoteMessage.data);\n\n   // Update a users messages list using AsyncStorage\n   const currentMessages = await AsyncStorage.getItem('messages');\n   const messageArray = JSON.parse(currentMessages);\n   messageArray.push(remoteMessage.data);\n   await AsyncStorage.setItem('messages', JSON.stringify(messageArray));\n});\n\n// Unsubscribe from further message events\nunsubscribe();\n```\n\n> This subscriber method is only called when the app is active (in the foreground).\n"},"parameters":[{"id":2037,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Called with a `RemoteMessage` when a new FCM payload is received from the server.\n"},"type":{"type":"reflection","declaration":{"id":2038,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2039,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2040,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"RemoteMessage","id":1955}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":604,"character":23}]}}}],"type":{"type":"reflection","declaration":{"id":2041,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2042,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":604,"character":57}]}}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":604,"character":13}]},{"id":2081,"name":"onMessageSent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2082,"name":"onMessageSent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"When sending a `RemoteMessage`, this listener is called when the message has been sent to FCM.","text":"Returns an unsubscribe function to stop listening for sent messages.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.messaging().onMessageSent((messageId) => {\n  console.log('Message has been sent to the FCM server', messageId);\n});\n\n// Unsubscribe from message sent events\nunsubscribe();\n```\n"},"parameters":[{"id":2083,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Called when the FCM sends the remote message to FCM.\n"},"type":{"type":"reflection","declaration":{"id":2084,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2085,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2086,"name":"messageId","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":829,"character":27}]}}}],"type":{"type":"reflection","declaration":{"id":2087,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2088,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":829,"character":56}]}}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":829,"character":17}]},{"id":2043,"name":"onNotificationOpenedApp","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2044,"name":"onNotificationOpenedApp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"When the user presses a notification displayed via FCM, this listener will be called if the app\nhas opened from a background state.","text":"See `getInitialNotification` to see how to watch for when a notification opens the app from a\nquit state.\n"},"parameters":[{"id":2045,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Called with a `RemoteMessage` when a notification press opens the application.\n"},"type":{"type":"reflection","declaration":{"id":2046,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2047,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2048,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"RemoteMessage","id":1955}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":615,"character":37}]}}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":615,"character":27}]},{"id":2089,"name":"onSendError","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2090,"name":"onSendError","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"When sending a `RemoteMessage`, this listener is called when an error is thrown and the\nmessage could not be sent.","text":"Returns an unsubscribe function to stop listening for sent errors.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.messaging().onSendError(({ messageId, error }) => {\n  console.log('An error occurred when sending a message to FCM', messageId, error);\n});\n\n// Unsubscribe from message sent error events\nunsubscribe();\n```\n"},"parameters":[{"id":2091,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"\n"},"type":{"type":"reflection","declaration":{"id":2092,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2093,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2094,"name":"evt","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"SendErrorEvent","id":2017}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":850,"character":25}]}}}],"type":{"type":"reflection","declaration":{"id":2095,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2096,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":850,"character":56}]}}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":850,"character":15}]},{"id":2049,"name":"onTokenRefresh","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2050,"name":"onTokenRefresh","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Called when a new registration token is generated for the device. For example, this event can happen when a\ntoken expires or when the server invalidates the token.","text":"Your app should always subscribe to this event and update your backend to ensure your device will\nreceive new messages. The listener is only called when the app is active (in foreground), so ensure\nyou call `getToken()` on app open to handle any new tokens generated when the app was not active.\n\nReturns an unsubscribe function to stop listening for token refresh events.\n\n#### Example\n\n```js\nconst unsubscribe = firebase.messaging().onTokenRefresh(async (fcmToken) => {\n  console.log('New FCM Token:', fcmToken);\n\n  // Append the database with the users new FCM token (e.g. with Firestore)\n  const uid = firebase.auth().currentUser.uid;\n  await firebase.firestore().doc(`users/${uid}`)\n    .update({\n      fcmTokens: firebase.firestore.FieldValues.arrayUnion(fcmToken),\n    });\n});\n```\n\n> This subscriber method is only called when the app is active (in the foreground).\n"},"parameters":[{"id":2051,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Called with a FCM token when the token is refreshed.\n"},"type":{"type":"reflection","declaration":{"id":2052,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2053,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2054,"name":"token","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":646,"character":28}]}}}],"type":{"type":"reflection","declaration":{"id":2055,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2056,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":646,"character":53}]}}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":646,"character":18}]},{"id":2062,"name":"registerDeviceForRemoteMessages","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2063,"name":"registerDeviceForRemoteMessages","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"On iOS, if your app wants to receive remote messages from FCM (via APNS), you must explicitly register\nthis request with APNS. For example if you want to display alerts, play sounds\nor perform other user-facing actions (via the Notification library), you must call this method.","text":"> You can safely call this method on Android without platform checks. It's a no-op on Android and will promise resolve `void`.\n\n> You can safely call this method multiple times, if the app is already registered then this method resolves immediately.\n\n#### Example\n\n```js\nif (!firebase.messaging().isDeviceRegisteredForRemoteMessages) {\n  await firebase.messaging().registerDeviceForRemoteMessages();\n}\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":696,"character":35}]},{"id":2060,"name":"registerForRemoteNotifications","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2061,"name":"registerForRemoteNotifications","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deprecated. See `registerDeviceForRemoteMessages` instead.","tags":[{"tag":"platform","text":"ios"},{"tag":"deprecated","text":"See registerDeviceForRemoteMessages.\n"}]},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":677,"character":34}]},{"id":2057,"name":"requestPermission","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2058,"name":"requestPermission","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"On iOS, messaging permission must be requested by the current application before messages can\nbe received or sent.","text":"On iOS < 12, a modal will be shown to the user requesting messaging permissions for the app.\nOnce handled, the promise will resolve with `true` if permission was granted.\n\nOn iOS >= 12, the app will be granted [Provisional Authorization](http://iosbrain.com/blog/2018/07/05/new-in-ios-12-implementing-provisional-authorization-for-quiet-notifications-in-swift/),\nand will resolve `true`. The user will be able to receive FCM payloads and Notifications immediately;\nbut notifications will be displayed silently. The user, through Notification Center, then has the option of upgrading your apps notifications to no longer be silent.\n\n> You can safely call this method on Android without platform checks. It's a no-op on Android and will promise resolve `true`.\n\n#### Example\n\n```js\nconst permissionGranted = await firebase.messaging().requestPermission();\n```\n","tags":[{"tag":"ios","text":"\n"}]},"parameters":[{"id":2059,"name":"permissions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"IOSPermissions","id":2005}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"AuthorizationStatus","id":2012}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":669,"character":21}]},{"id":2103,"name":"sendMessage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2104,"name":"sendMessage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Send a new `RemoteMessage` to the FCM server.","text":"The promise resolves when the message has been added to the internal queue. Use `onMessageSent()`\nand `onSendError()` to determine when the message has been sent to the server.\n\n#### Example\n\n```js\nawait firebase.messaging().sendMessage({\n  data: {\n    loggedIn: Date.now(),\n    uid: firebase.auth().currentUser.uid,\n  }\n});\n```\n"},"parameters":[{"id":2105,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A `RemoteMessage` interface.\n"},"type":{"type":"reference","name":"RemoteMessage","id":1955}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":897,"character":15}]},{"id":2022,"name":"setAutoInitEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2023,"name":"setAutoInitEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets whether auto initialization for messaging is enabled or disabled.","text":"Set this to false to allow for an 'opt-in-first' flow for your users. By default auto\ninitialization is enabled, which updates the device identifier and configuration data needed\nfor messaging to Firebase.\n\nTo ensure first app opens have an initial value set, set the argument in the `firebase.json`\nconfig.\n\n#### Example\n\n```js\n// Disable auto initialization\nawait firebase.messaging().setAutoInitEnabled(false);\n```\n"},"parameters":[{"id":2024,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A boolean value to enable or disable auto initialization.\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":500,"character":22}]},{"id":2097,"name":"setBackgroundMessageHandler","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2098,"name":"setBackgroundMessageHandler","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"On Android, set a message handler function which is called when the app is in the background\nor terminated. A headless task is created, allowing you to access the React Native environment\nto perform tasks such as updating local storage, or sending a network request.","text":"This method must be called **outside** of your application lifecycle, e.g. alongside your\n`AppRegistry.registerComponent()` method call at the the entry point of your application code.\n\n> You can safely call this method on iOS without platform checks. It's a no-op on iOS.\n\n#### Example\n\n```js\nfirebase.messaging().setBackgroundMessageHandler(async (remoteMessage) => {\n   // Update a users messages list using AsyncStorage\n   const currentMessages = await AsyncStorage.getItem('messages');\n   const messageArray = JSON.parse(currentMessages);\n   messageArray.push(remoteMessage.data);\n   await AsyncStorage.setItem('messages', JSON.stringify(messageArray));\n});\n```\n","tags":[{"tag":"android","text":"\n"}]},"parameters":[{"id":2099,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":2100,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2101,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2102,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"RemoteMessage","id":1955}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"any"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":876,"character":40}]}}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":876,"character":31}]},{"id":2106,"name":"subscribeToTopic","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2107,"name":"subscribeToTopic","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Apps can subscribe to a topic, which allows the FCM server to send targeted messages to only those\ndevices subscribed to that topic.","text":"#### Example\n\n```js\nawait firebase.messaging().subscribeToTopic('news');\n```\n"},"parameters":[{"id":2108,"name":"topic","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The topic name.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":911,"character":20}]},{"id":2068,"name":"unregisterDeviceForRemoteMessages","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2069,"name":"unregisterDeviceForRemoteMessages","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unregisters the app from receiving remote notifications.","text":"> You can safely call this method on Android without platform checks. It's a no-op on Android and will promise resolve `void`.\n\n#### Example\n\n```js\nif (firebase.messaging().isDeviceRegisteredForRemoteMessages) {\n  await firebase.messaging().unregisterDeviceForRemoteMessages();\n}\n```\n","tags":[{"tag":"platform","text":"ios\n"}]},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":745,"character":37}]},{"id":2066,"name":"unregisterForRemoteNotifications","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2067,"name":"unregisterForRemoteNotifications","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deprecated. See `unregisterDeviceForRemoteMessages` instead.","tags":[{"tag":"platform","text":"ios"},{"tag":"deprecated","text":"See unregisterDeviceForRemoteMessages.\n"}]},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":728,"character":36}]},{"id":2109,"name":"unsubscribeFromTopic","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2110,"name":"unsubscribeFromTopic","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unsubscribe the device from a topic.","text":"#### Example\n\n```js\nawait firebase.messaging().unsubscribeFromTopic('news');\n```\n"},"parameters":[{"id":2111,"name":"topic","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The topic name.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":924,"character":24}]}],"groups":[{"title":"Properties","kind":1024,"children":[2112,2021,2065,2064]},{"title":"Methods","kind":2048,"children":[2031,2070,2025,2027,2072,2074,2035,2081,2043,2089,2049,2062,2060,2057,2103,2022,2097,2106,2068,2066,2109]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":469,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":2005,"name":"IOSPermissions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An interface representing all the available permissions that can be requested by your app via\nthe `requestPermission` API."},"children":[{"id":2006,"name":"alert","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Request permission to display alerts.","text":"Defaults to true.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":353,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2007,"name":"announcement","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Request permission for Siri to automatically read out notification messages over AirPods.","text":"Defaults to false.\n","tags":[{"tag":"platform","text":"ios iOS >= 13\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":362,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2008,"name":"badge","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Request permission to update the application badge.","text":"Defaults to true.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":369,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2009,"name":"carPlay","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Request permission to display notifications in a CarPlay environment.","text":"Defaults to true.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":376,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2010,"name":"provisional","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Request permission to provisionally create non-interrupting notifications.","text":"Defaults to false.\n","tags":[{"tag":"platform","text":"ios iOS >= 12\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":385,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2011,"name":"sound","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Request permission to play sounds.","text":"Defaults to true.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":392,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2006,2007,2008,2009,2010,2011]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":347,"character":33}]},{"id":1970,"name":"Notification","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":1978,"name":"android","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Additional Android specific properties set on the notification."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":171,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1979,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1981,"name":"channelId","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The channel ID set on the notification. If not set, the notification uses the default\n\"Miscellaneous\" channel set by FCM."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":183,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1987,"name":"clickAction","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"Name of the click action set on the notification."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":214,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1982,"name":"color","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The custom color used to tint the notification content."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":188,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1986,"name":"count","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The current unread notification count for this application, managed by the device."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":209,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":1984,"name":"imageUrl","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The custom image was provided and displayed in the notification body."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":199,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1985,"name":"link","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"Deep link URL provided to the notification."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":204,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1988,"name":"priority","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The notification priority.","text":"Note; on devices which have channel support (Android 8.0 (API level 26) +),\nthis value will be ignored. Instead, the channel \"importance\" level is used.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":222,"character":14}],"type":{"type":"union","types":[{"type":"reference","name":"PRIORITY_MIN","id":1996},{"type":"reference","name":"PRIORITY_LOW","id":1997},{"type":"reference","name":"PRIORITY_DEFAULT","id":1998},{"type":"reference","name":"PRIORITY_HIGH","id":1999},{"type":"reference","name":"PRIORITY_MAX","id":2000}]}},{"id":1983,"name":"smallIcon","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The custom small icon used to display on the notification. If not set, uses the default\napplication icon defined in the AndroidManifest file."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":194,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1980,"name":"sound","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The sound played when the notification was delivered on the device (channel settings permitted).","text":"Set as \"default\" if the default device notification sound was used.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":177,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1989,"name":"ticker","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"Ticker text set on the notification.","text":"Ticker text is used for devices with accessibility enabled (e.g. to read out the message).\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":234,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1990,"name":"visibility","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The visibility of a notification. This value determines how the notification is shown on the users\ndevices (e.g. on the lock-screen)."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":240,"character":16}],"type":{"type":"union","types":[{"type":"reference","name":"VISIBILITY_SECRET","id":2002},{"type":"reference","name":"VISIBILITY_PRIVATE","id":2003},{"type":"reference","name":"VISIBILITY_PUBLIC","id":2004}]}}],"groups":[{"title":"Variables","kind":32,"children":[1981,1987,1982,1986,1984,1985,1988,1983,1980,1989,1990]}]}}]}},{"id":1972,"name":"body","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The notification body content."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":147,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1973,"name":"ios","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":149,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1974,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1976,"name":"badge","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The value of the badge on the home screen app icon.\nIf not specified, the badge is not changed.\nIf set to 0, the badge has been removed."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":160,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1977,"name":"sound","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The sound played when the notification was delivered on the device (if permissions permit)."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":165,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"NotificationIOSCriticalSound","id":1991}]}},{"id":1975,"name":"subtitle","kind":32,"kindString":"Variable","flags":{"isOptional":true},"comment":{"shortText":"The notification's subtitle."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":153,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Variables","kind":32,"children":[1976,1977,1975]}]}}]}},{"id":1971,"name":"title","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The notification title."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":142,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1978,1972,1973,1971]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":138,"character":31}]},{"id":1991,"name":"NotificationIOSCriticalSound","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a critical sound configuration that can be included in the\n`aps` dictionary of an APNs payload."},"children":[{"id":1992,"name":"critical","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The critical alert flag. Set to `true` to enable the critical alert."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":255,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":1993,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The name of a sound file in the app's main bundle or in the `Library/Sounds`\nfolder of the app's container directory. Specify the string \"default\" to play\nthe system sound."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":262,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":1994,"name":"volume","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The volume for the critical alert's sound. Must be a value between 0.0\n(silent) and 1.0 (full volume)."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":268,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1992,1993,1994]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":251,"character":47}]},{"id":1955,"name":"RemoteMessage","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The `RemoteMessage` interface describes an outgoing & incoming message from the remote FCM server."},"children":[{"id":1968,"name":"category","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The iOS category this notification is assigned to.","tags":[{"tag":"platform","text":"ios iOS\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":130,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1956,"name":"collapseKey","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The collapse key a message was sent with. Used to override existing messages with the same\nkey."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":74,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1966,"name":"contentAvailable","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Whether the iOS APNS message was configured as a background update notification.","tags":[{"tag":"platform","text":"ios iOS\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":115,"character":20}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":1961,"name":"data","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Any additional data sent with the message."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":103,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reflection","declaration":{"id":1962,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":1963,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":1964,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}]}}]}},{"id":1957,"name":"messageId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A unique ID assigned to every message.","text":"If not provided, a random unique ID is generated.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":81,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1958,"name":"messageType","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The message type of the message."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":86,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1967,"name":"mutableContent","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Whether the iOS APNS `mutable-content` property on the message was set\nallowing the app to modify the notification via app extensions.","tags":[{"tag":"platform","text":"ios iOS\n"}]},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":123,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":1965,"name":"notification","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Additional Notification data sent with the message"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":108,"character":16}],"type":{"type":"reference","name":"Notification","id":1970}},{"id":1969,"name":"threadId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An iOS app specific identifier used for notification grouping."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":135,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1959,"name":"to","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The address for the message."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":91,"character":6}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":1960,"name":"ttl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The time to live for the message in seconds.","text":"Defaults to 3600.\n"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":98,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[1968,1956,1966,1961,1957,1958,1967,1965,1969,1959,1960]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":69,"character":32}]},{"id":2017,"name":"SendErrorEvent","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An event that is received when a message fails to send.","text":"### Example\n\n```js\nfirebase.messaging().onSendError(event => {\n  console.log(event.messageId);\n  console.log(event.error);\n});\n"},"children":[{"id":2019,"name":"error","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A native firebase error that indicates the failure reason."},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":453,"character":9}],"type":{"type":"reference","name":"NativeFirebaseError","id":2}},{"id":2018,"name":"messageId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The id of the message that failed to send"},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":448,"character":13}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2019,2018]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":444,"character":33}]},{"id":1951,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":1952,"name":"AuthorizationStatus","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":61,"character":23}],"type":{"type":"reference","name":"AuthorizationStatus","id":2012}},{"id":1953,"name":"NotificationAndroidPriority","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":62,"character":31}],"type":{"type":"reference","name":"NotificationAndroidPriority","id":1995}},{"id":1954,"name":"NotificationAndroidVisibility","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":63,"character":33}],"type":{"type":"reference","name":"NotificationAndroidVisibility","id":2001}}],"groups":[{"title":"Properties","kind":1024,"children":[1952,1953,1954]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":60,"character":26}]}],"groups":[{"title":"Enumerations","kind":4,"children":[2012,1995,2001]},{"title":"Classes","kind":128,"children":[2020]},{"title":"Interfaces","kind":256,"children":[2005,1970,1991,1955,2017,1951]}],"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":56,"character":39}]},{"id":2536,"name":"FirebasePerformanceTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Performance Monitoring package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `perf` package:\n\n```js\nimport { firebase } from '@react-native-firebase/perf';\n\n// firebase.perf().X\n```\n\n#### Example 2\n\nUsing the default export from the `perf` package:\n\n```js\nimport perf from '@react-native-firebase/perf';\n\n// perf().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/perf';\n\n// firebase.perf().X\n```\n","tags":[{"tag":"firebase","text":"perf\n"}]},"children":[{"id":2568,"name":"HttpMetric","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Metric used to collect data for network requests/responses. A new instance must be used for every request/response."},"children":[{"id":2569,"name":"getAttribute","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2570,"name":"getAttribute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the value of an attribute. Returns null if it does not exist.","text":"#### Example\n\n```js\nconst attribute = metric.getAttribute('user_role');\n```\n"},"parameters":[{"id":2571,"name":"attribute","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the attribute to fetch the value of\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":229,"character":16}]},{"id":2572,"name":"getAttributes","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2573,"name":"getAttributes","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an object of all the currently added attributes.","text":"#### Example\n\n```js\nconst attributes = metric.getAttributes();\n\nattributes.forEach(($) => {\n  console.log($);\n});\n```\n"},"type":{"type":"reflection","declaration":{"id":2574,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":2575,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":2576,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":244,"character":20}]}}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":244,"character":17}]},{"id":2577,"name":"putAttribute","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2578,"name":"putAttribute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a String value for the specified attribute. Updates the value of the attribute if it already exists.\nThe maximum number of attributes that can be added is 5.","text":"#### Example\n\n```js\nmetric.putAttribute('user_role', 'admin');\n```\n"},"parameters":[{"id":2579,"name":"attribute","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the attribute. Max length is 40 chars."},"type":{"type":"intrinsic","name":"string"}},{"id":2580,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Value of the attribute. Max length is 100 chars.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":259,"character":16}]},{"id":2581,"name":"removeAttribute","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2582,"name":"removeAttribute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes an already added attribute. Does nothing if attribute does not exist.","text":"#### Example\n\n```js\nmetric.removeAttribute('user_role');\n```\n"},"parameters":[{"id":2583,"name":"attribute","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the attribute to be removed.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":272,"character":19}]},{"id":2584,"name":"setHttpResponseCode","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2585,"name":"setHttpResponseCode","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the httpResponse code of the request.","text":"#### Example\n\n```js\nconst response = await fetch(url);\nmetric.setHttpResponseCode(response.status);\n```\n> This is required for every request, if you do not provide this your metric will not be captured.\n\n"},"parameters":[{"id":2586,"name":"code","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Value must be greater than 0. Set to null to remove. Invalid usage will be logged natively.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":288,"character":23}]},{"id":2587,"name":"setRequestPayloadSize","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2588,"name":"setRequestPayloadSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the size of the request payload.","text":"#### Example\n\n```js\nconst response = await fetch(url);\nmetric.setRequestPayloadSize(response.headers.get('Content-Type'));\n```\n"},"parameters":[{"id":2589,"name":"bytes","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Value must be greater than 0. Set to null to remove. Invalid usage will be logged natively.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":302,"character":25}]},{"id":2593,"name":"setResponseContentType","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2594,"name":"setResponseContentType","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Content type of the response e.g. `text/html` or `application/json`.","text":"#### Example\n\n```js\nconst response = await fetch(url);\nmetric.setResponsePayloadSize(response.headers.get('Content-Type'));\n```\n"},"parameters":[{"id":2595,"name":"contentType","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Valid string of MIME type. Set to null to remove. Invalid usage will be logged natively.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":330,"character":26}]},{"id":2590,"name":"setResponsePayloadSize","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2591,"name":"setResponsePayloadSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the size of the response payload.","text":"#### Example\n\n```js\nconst response = await fetch(url);\nmetric.setResponsePayloadSize(response.headers.get('Content-Length'));\n```\n"},"parameters":[{"id":2592,"name":"bytes","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Value must be greater than 0. Set to null to remove. Invalid usage will be logged natively.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":316,"character":26}]},{"id":2596,"name":"start","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2597,"name":"start","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Marks the start time of the request. Does nothing if already started.","text":"#### Example\n\n```js\nconst metric = firebase.perf().newHttpMetric('https://api.com/login', 'POST');\nawait metric.start();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":342,"character":9}]},{"id":2598,"name":"stop","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2599,"name":"stop","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Marks the end time of the response and queues the network request metric on the device for transmission. Does nothing if already stopped.","text":"#### Example\n\n```js\nconst metric = firebase.perf().newHttpMetric('https://api.com/login', 'POST');\nawait metric.start();\nmetric.putAttribute('user_role', 'admin');\nawait metric.stop();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":356,"character":8}]}],"groups":[{"title":"Methods","kind":2048,"children":[2569,2572,2577,2581,2584,2587,2593,2590,2596,2598]}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":217,"character":25}]},{"id":2601,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Performance Monitoring service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Performance Monitoring service for the default app:\n\n```js\nconst defaultAppPerf = firebase.perf();\n```\n"},"children":[{"id":2616,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":2602,"name":"isPerformanceCollectionEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Determines whether performance monitoring is enabled or disabled.","text":"#### Example\n\n```js\nconst isEnabled = firebase.perf().isPerformanceCollectionEnabled;\nconsole.log('Performance collection enabled: ', isEnabled);\n```\n"},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":385,"character":34}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2612,"name":"newHttpMetric","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2613,"name":"newHttpMetric","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a HttpMetric instance for collecting network performance data for a single request/response","text":"#### Example\n\n```js\nconst metric = firebase.perf().newHttpMetric('https://api.com/user/1', 'GET');\nawait metric.start();\n```\n"},"parameters":[{"id":2614,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A valid url String, cannot be empty"},"type":{"type":"intrinsic","name":"string"}},{"id":2615,"name":"httpMethod","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"One of the values GET, PUT, POST, DELETE, HEAD, PATCH, OPTIONS, TRACE, or CONNECT\n"},"type":{"type":"reference","name":"HttpMethod","id":2617}}],"type":{"type":"reference","name":"HttpMetric","id":2568}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":441,"character":17}]},{"id":2606,"name":"newTrace","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2607,"name":"newTrace","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Trace instance with the given identifier.","text":"#### Example\n\n```js\nconst trace = firebase.perf().newTrace('user_profile');\nawait trace.start();\n```\n"},"parameters":[{"id":2608,"name":"identifier","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the trace, no leading or trailing whitespace allowed, no leading underscore '_' character allowed, max length is 100.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Trace","id":2537}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":413,"character":12}]},{"id":2603,"name":"setPerformanceCollectionEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2604,"name":"setPerformanceCollectionEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Enables or disables performance monitoring.","text":"#### Example\n\n```js\n// Disable performance monitoring collection\nawait firebase.perf().setPerformanceCollectionEnabled(false);\n```\n"},"parameters":[{"id":2605,"name":"enabled","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Should performance monitoring be enabled\n"},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":399,"character":35}]},{"id":2609,"name":"startTrace","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2610,"name":"startTrace","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a Trace instance with the given identifier and immediately starts it.","text":"#### Example\n\n```js\nconst trace = await firebase.perf().startTrace('user_profile');\n```\n"},"parameters":[{"id":2611,"name":"identifier","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the trace, no leading or trailing whitespace allowed, no leading underscore '_' character allowed, max length is 100.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"Trace","id":2537}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":426,"character":14}]}],"groups":[{"title":"Properties","kind":1024,"children":[2616,2602]},{"title":"Methods","kind":2048,"children":[2612,2606,2603,2609]}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":374,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":2537,"name":"Trace","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Trace allows you to time the beginning to end of a certain action in your app with additional metric values and attributes."},"children":[{"id":2538,"name":"getAttribute","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2539,"name":"getAttribute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the value of an attribute. Returns null if it does not exist.","text":"#### Example\n\n```js\nconst attribute = trace.getAttribute('userId');\n```\n"},"parameters":[{"id":2540,"name":"attribute","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the attribute to fetch the value of.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":97,"character":16}]},{"id":2545,"name":"getMetric","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2546,"name":"getMetric","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the value of the metric with the given name in the current trace. If the metric\ndoesn't exist, it will not be created and a 0 is returned.","text":"#### Example\n\n```js\nconst metric = trace.getMetric('hits');\n```\n"},"parameters":[{"id":2547,"name":"metricName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the metric to get.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"number"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":126,"character":13}]},{"id":2548,"name":"getMetrics","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2549,"name":"getMetrics","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an object of all the currently added metrics and their number values.","text":"#### Example\n\n```js\nconst metrics = trace.getMetrics();\n\nmetrics.forEach(($) => {\n  console.log($);\n});\n```\n"},"type":{"type":"reflection","declaration":{"id":2550,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":2551,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":2552,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"number"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":141,"character":17}]}}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":141,"character":14}]},{"id":2557,"name":"incrementMetric","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2558,"name":"incrementMetric","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Increments the named metric by the `incrementBy` value.","text":"If a metric with the given name doesn't exist, a new one will be created starting with the value of `incrementBy`.\n\n```js\ntrace.incrementMetric('hits', 1);\n```\n"},"parameters":[{"id":2559,"name":"metricName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the metric to increment. Must not have a leading or trailing whitespace, no leading underscore '_' character and have a max length of 32 characters."},"type":{"type":"intrinsic","name":"string"}},{"id":2560,"name":"incrementBy","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value the metric should be incremented by.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":172,"character":19}]},{"id":2541,"name":"putAttribute","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2542,"name":"putAttribute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a String value for the specified attribute. Updates the value of the attribute if it already exists.\nThe maximum number of attributes that can be added is 5.","text":"#### Example\n\n```js\ntrace.putAttribute('userId', '123456789');\n```\n"},"parameters":[{"id":2543,"name":"attribute","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the attribute. Max length is 40 chars."},"type":{"type":"intrinsic","name":"string"}},{"id":2544,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Value of the attribute. Max length is 100 chars.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":112,"character":16}]},{"id":2553,"name":"putMetric","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2554,"name":"putMetric","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the value of the named metric with the provided number.","text":"If a metric with the given name exists it will be overwritten.\nIf a metric with the given name doesn't exist, a new one will be created.\n\n#### Example\n\n```js\ntrace.putMetric('hits', 1);\n```\n"},"parameters":[{"id":2555,"name":"metricName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the metric to set. Must not have a leading or trailing whitespace, no leading underscore '_' character and have a max length of 32 characters."},"type":{"type":"intrinsic","name":"string"}},{"id":2556,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value the metric should be set to.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":158,"character":13}]},{"id":2561,"name":"removeMetric","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2562,"name":"removeMetric","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes a metric by name if it exists.","text":"#### Example\n\n```js\ntrace.removeMetric('hits');\n```\n"},"parameters":[{"id":2563,"name":"metricName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Name of the metric to remove.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":185,"character":16}]},{"id":2564,"name":"start","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2565,"name":"start","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Marks the start time of the trace. Does nothing if already started.","text":"#### Example\n\n```js\nconst trace = firebase.perf().newTrace('example');\nawait trace.start();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":197,"character":9}]},{"id":2566,"name":"stop","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2567,"name":"stop","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Marks the end time of the trace and queues the metric on the device for transmission. Does nothing if already stopped.","text":"* #### Example\n\n```js\nconst trace = firebase.perf().newTrace('example');\nawait trace.start();\ntrace.putMetric('hits', 1);\nawait trace.stop();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":211,"character":8}]}],"groups":[{"title":"Methods","kind":2048,"children":[2538,2545,2548,2557,2541,2553,2561,2564,2566]}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":85,"character":20}]},{"id":2600,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":359,"character":26}]},{"id":2617,"name":"HttpMethod","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"Valid HTTP methods."},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":71,"character":24}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"GET"},{"type":"stringLiteral","value":"HEAD"},{"type":"stringLiteral","value":"PUT"},{"type":"stringLiteral","value":"POST"},{"type":"stringLiteral","value":"PATCH"},{"type":"stringLiteral","value":"TRACE"},{"type":"stringLiteral","value":"DELETE"},{"type":"stringLiteral","value":"CONNECT"},{"type":"stringLiteral","value":"OPTIONS"}]}}],"groups":[{"title":"Classes","kind":128,"children":[2568,2601,2537]},{"title":"Interfaces","kind":256,"children":[2600]},{"title":"Type aliases","kind":4194304,"children":[2617]}],"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":56,"character":41}]},{"id":2626,"name":"FirebaseRemoteConfigTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Remote RemoteConfig package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `config` package:\n\n```js\nimport { firebase } from '@react-native-firebase/remote-config';\n\n// firebase.remoteConfig().X\n```\n\n#### Example 2\n\nUsing the default export from the `config` package:\n\n```js\nimport remoteConfig from '@react-native-firebase/remote-config';\n\n// remoteConfig().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/remote-config';\n\n// firebase.remoteConfig().X\n```\n","tags":[{"tag":"firebase","text":"remote-config\n"}]},"children":[{"id":2651,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase Remote RemoteConfig service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Remote RemoteConfig service for the default app:\n\n```js\nconst defaultAppRemoteConfig = firebase.remoteConfig();\n```\n"},"children":[{"id":2676,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":2653,"name":"isDeveloperModeEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Whether developer mode is enabled. This is set manually via {@link config#setConfigSettings}"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":287,"character":26}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2654,"name":"lastFetchStatus","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The status of the latest Remote RemoteConfig fetch action.","text":"See the `LastFetchStatus` statics definition.\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":293,"character":19}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"success"},{"type":"stringLiteral","value":"failure"},{"type":"stringLiteral","value":"no_fetch_yet"},{"type":"stringLiteral","value":"throttled"}]}},{"id":2652,"name":"lastFetchTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The number of milliseconds since the last Remote RemoteConfig fetch was performed."},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":283,"character":17}],"type":{"type":"intrinsic","name":"number"}},{"id":2655,"name":"activate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2656,"name":"activate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Moves fetched data to the apps active config.\nResolves with a boolean value of whether the fetched config was moved successfully.","text":"#### Example\n\n```js\n// Fetch values\nawait firebase.remoteConfig().fetch();\nconst activated = await firebase.remoteConfig().activate();\n\nif (activated) {\n console.log('Fetched values successfully activated.');\n} else {\n  console.log('Fetched values failed to activate.');\n}\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"boolean"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":313,"character":12}]},{"id":2657,"name":"fetch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2658,"name":"fetch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Fetches the remote config data from Firebase, as defined in the dashboard. If duration is defined (seconds), data will be locally cached for this duration.","text":"#### Example\n\n```js\n// Fetch and cache for 5 minutes\nawait firebase.remoteConfig().fetch(300);\n```\n"},"parameters":[{"id":2659,"name":"expirationDurationSeconds","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Duration in seconds to cache the data for. To skip cache, use a duration of 0.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":327,"character":9}]},{"id":2660,"name":"fetchAndActivate","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2661,"name":"fetchAndActivate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Fetches the remote config data from Firebase, as defined in the dashboard.","text":"Once fetching is complete this method immediately calls activate and returns a boolean value of the activation status.\n\n#### Example\n\n```js\n// Fetch, cache for 5 minutes and activate\nconst activated = await firebase.remoteConfig().fetchAndActivate();\n\nif (activated) {\n console.log('Fetched values successfully activated.');\n} else {\n  console.log('Fetched values failed to activate.');\n}\n```\n\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"boolean"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":348,"character":20}]},{"id":2662,"name":"getAll","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2663,"name":"getAll","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns all available config values.","text":"#### Example\n\n```js\nconst values = firebase.remoteConfig().getAll();\n\nObject.entries(values).forEach(($) => {\n  const [key, entry] = $;\n  console.log('Key: ', key);\n  console.log('Source: ', entry.source);\n  console.log('Value: ', entry.value);\n});\n```\n\n"},"type":{"type":"reference","name":"ConfigValues","id":2642}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":367,"character":10}]},{"id":2664,"name":"getValue","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2665,"name":"getValue","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a ConfigValue by key.","text":"#### Example\n\n```js\nconst configValue = firebase.remoteConfig().getValue('experiment');\nconsole.log('Source: ', configValue.source);\nconsole.log('Value: ', configValue.value);\n```\n"},"parameters":[{"id":2666,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A key used to retrieve a specific value.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"ConfigValue","id":2639}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":382,"character":12}]},{"id":2667,"name":"setConfigSettings","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2668,"name":"setConfigSettings","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Set the Remote RemoteConfig settings, specifically the `isDeveloperModeEnabled` flag.","text":"#### Example\n\n```js\nawait firebase.remoteConfig().setConfigSettings({\n  isDeveloperModeEnabled: __DEV__,\n});\n```\n"},"parameters":[{"id":2669,"name":"configSettings","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A ConfigSettingsWrite instance used to set Remote RemoteConfig settings.\n"},"type":{"type":"reference","name":"ConfigSettings","id":2645}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":397,"character":21}]},{"id":2670,"name":"setDefaults","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2671,"name":"setDefaults","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets default values for the app to use when accessing values.\nAny data fetched and activated will override any default values. Any values in the defaults but not on Firebase will be untouched.","text":"#### Example\n\n```js\nawait firebase.remoteConfig().setDefaults({\n  experiment_enabled: false,\n});\n```\n"},"parameters":[{"id":2672,"name":"defaults","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A ConfigDefaults instance used to set default values.\n"},"type":{"type":"reference","name":"ConfigDefaults","id":2648}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":413,"character":15}]},{"id":2673,"name":"setDefaultsFromResource","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2674,"name":"setDefaultsFromResource","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the default values from a resource file.\nOn iOS this is a plist file and on Android this is an XML defaultsMap file.","text":"```js\n // TODO @ehesp\n```\n"},"parameters":[{"id":2675,"name":"resourceName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The plist/xml file name with no extension.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"null"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":425,"character":27}]}],"groups":[{"title":"Properties","kind":1024,"children":[2676,2653,2654,2652]},{"title":"Methods","kind":2048,"children":[2655,2657,2660,2662,2664,2667,2670,2673]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":279,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":2648,"name":"ConfigDefaults","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An Interface representing a RemoteConfig Defaults object.","text":"#### Example\n\n```js\nawait firebase.remoteConfig().setDefaults({\n  experiment_enabled: false,\n});\n```\n"},"indexSignature":[{"id":2649,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"comment":{"shortText":"An Interface representing a RemoteConfig Defaults object.","text":"#### Example\n\n```js\nawait firebase.remoteConfig().setDefaults({\n  experiment_enabled: false,\n});\n```\n"},"parameters":[{"id":2650,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"}]}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":262,"character":33}]},{"id":2645,"name":"ConfigSettings","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An Interface representing settable config settings.","text":"#### Example\n\nThe example below makes use of the React Native `__DEV__` global JavaScript variable which\nis exposed.\n\n```js\nawait firebase.remoteConfig().setConfigSettings({\n  isDeveloperModeEnabled: __DEV__,\n});\n```\n"},"children":[{"id":2646,"name":"isDeveloperModeEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If enabled, default behaviour such as caching is disabled for a better debugging\nexperience."},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":244,"character":26}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2647,"name":"minimumFetchInterval","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The time that remote config should cache flags for."},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":248,"character":24}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2646,2647]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":239,"character":33}]},{"id":2639,"name":"ConfigValue","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An Interface representing a Remote RemoteConfig value."},"children":[{"id":2640,"name":"source","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Where the value was retrieved from.","text":"- `remote`:  If the value was retrieved from the server.\n- `default`: If the value was set as a default value.\n- `static`: If no value was found and a static default value was returned instead.\n\nSee the `ValueSource` statics definition.\n\n#### Example\n\n```js\nconst configValue = firebase.remoteConfig().getValue('beta_enabled');\nconsole.log('Value source: ', configValue.source);\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":197,"character":10}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"remote"},{"type":"stringLiteral","value":"default"},{"type":"stringLiteral","value":"static"}]}},{"id":2641,"name":"value","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The returned value.","text":"#### Example\n\n```js\nconst configValue = firebase.remoteConfig().getValue('beta_enabled');\nconsole.log('Value: ', configValue.value);\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":209,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2640,2641]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":180,"character":30}]},{"id":2642,"name":"ConfigValues","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An Interface representing multiple RemoteConfig Values.","text":"#### Example\n\n```js\nconst values = firebase.remoteConfig().getAll();\n```\n"},"indexSignature":[{"id":2643,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"comment":{"shortText":"An Interface representing multiple RemoteConfig Values.","text":"#### Example\n\n```js\nconst values = firebase.remoteConfig().getAll();\n```\n"},"parameters":[{"id":2644,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"ConfigValue","id":2639}}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":221,"character":31}]},{"id":2627,"name":"LastFetchStatus","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A pseudo-enum for usage with ConfigSettingsRead.lastFetchStatus to determine the last fetch status.","text":"#### Example\n\n```js\nfirebase.remoteConfig.LastFetchStatus;\n```\n"},"children":[{"id":2629,"name":"FAILURE","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A value indicating that the last fetch failed.","text":"```js\nfirebase.remoteConfig.LastFetchStatus.FAILURE;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":85,"character":11}],"type":{"type":"stringLiteral","value":"failure"}},{"id":2631,"name":"NO_FETCH_YET","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A value indicating that no fetches have occurred yet.","text":"This usually means you've not called fetch yet.\n\n```js\nfirebase.remoteConfig.LastFetchStatus.NO_FETCH_YET;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":107,"character":16}],"type":{"type":"stringLiteral","value":"no_fetch_yet"}},{"id":2628,"name":"SUCCESS","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A value indicating that the last fetch was successful.","text":"```js\nfirebase.remoteConfig.LastFetchStatus.SUCCESS;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":76,"character":11}],"type":{"type":"stringLiteral","value":"success"}},{"id":2630,"name":"THROTTLED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A value indicating that the last fetch was throttled.","text":"This usually occurs when calling fetch often with a low expiration duration.\n\n```js\nfirebase.remoteConfig.LastFetchStatus.THROTTLED;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":96,"character":13}],"type":{"type":"stringLiteral","value":"throttled"}}],"groups":[{"title":"Properties","kind":1024,"children":[2629,2631,2628,2630]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":68,"character":34}]},{"id":2636,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Firebase Remote RemoteConfig statics.","text":"```js\nfirebase.config;\n```\n"},"children":[{"id":2638,"name":"LastFetchStatus","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A pseudo-enum for usage with `firebase.remoteConfig().lastFetchStatus` to determine the last fetch status.","text":"#### Example\n\n```js\nfirebase.remoteConfig.LastFetchStatus;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":174,"character":19}],"type":{"type":"reference","name":"LastFetchStatus","id":2627}},{"id":2637,"name":"ValueSource","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A pseudo-enum for usage with ConfigValue.source to determine the value source.","text":"#### Example\n\n```js\nfirebase.remoteConfig.ValueSource;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":163,"character":15}],"type":{"type":"reference","name":"ValueSource","id":2632}}],"groups":[{"title":"Properties","kind":1024,"children":[2638,2637]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":153,"character":26}]},{"id":2632,"name":"ValueSource","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A pseudo-enum for usage with ConfigValue.source to determine the value source.","text":"#### Example\n\n```js\nfirebase.remoteConfig.ValueSource;\n```\n"},"children":[{"id":2634,"name":"DEFAULT","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If the value was set as a default value.","text":"```js\nfirebase.remoteConfig.ValueSource.DEFAULT;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":135,"character":11}],"type":{"type":"stringLiteral","value":"default"}},{"id":2633,"name":"REMOTE","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If the value was retrieved from the server.","text":"```js\nfirebase.remoteConfig.ValueSource.REMOTE;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":127,"character":10}],"type":{"type":"stringLiteral","value":"remote"}},{"id":2635,"name":"STATIC","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If no value was found and a static default value was returned instead.","text":"```js\nfirebase.remoteConfig.ValueSource.STATIC;\n```\n"},"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":143,"character":10}],"type":{"type":"stringLiteral","value":"static"}}],"groups":[{"title":"Properties","kind":1024,"children":[2634,2633,2635]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":119,"character":30}]}],"groups":[{"title":"Classes","kind":128,"children":[2651]},{"title":"Interfaces","kind":256,"children":[2648,2645,2639,2642,2627,2636,2632]}],"sources":[{"fileName":"packages/remote-config/lib/index.d.ts","line":56,"character":42}]},{"id":2684,"name":"FirebaseStorageTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase Cloud Storage package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `storage` package:\n\n```js\nimport { firebase } from '@react-native-firebase/storage';\n\n// firebase.storage().X\n```\n\n#### Example 2\n\nUsing the default export from the `storage` package:\n\n```js\nimport storage from '@react-native-firebase/storage';\n\n// storage().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/storage';\n\n// firebase.storage().X\n```\n","tags":[{"tag":"firebase","text":"storage\n"}]},"children":[{"id":2840,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Cloud Storage service is available for the default app, a given app or a specific storage bucket.","text":"#### Example 1\n\nGet the storage instance for the **default app**:\n\n```js\nconst storageForDefaultApp = firebase.storage();\n```\n\n#### Example 2\n\nGet the storage instance for a **secondary app**:\n\n```js\nconst otherApp = firebase.app('otherApp');\nconst storageForOtherApp = firebase.storage(otherApp);\n```\n\n#### Example 3\n\nGet the storage instance for a **specific storage bucket**:\n\n```js\nconst defaultApp = firebase.app();\nconst storageForBucket = defaultApp.storage('gs://another-bucket-url');\n\nconst otherApp = firebase.app('otherApp');\nconst storageForOtherAppBucket = otherApp.storage('gs://another-bucket-url');\n```\n\n"},"children":[{"id":2859,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":2845,"name":"maxDownloadRetryTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the current maximum time in milliseconds to retry a download if a failure occurs.","text":"#### Example\n\n```js\nconst downloadRetryTime = firebase.storage().maxUploadRetryTime;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1026,"character":24}],"type":{"type":"intrinsic","name":"number"}},{"id":2849,"name":"maxOperationRetryTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the current maximum time in milliseconds to retry operations other than upload and download if a failure occurs.","text":"#### Example\n\n```js\nconst maxOperationRetryTime = firebase.storage().maxOperationRetryTime;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1050,"character":25}],"type":{"type":"intrinsic","name":"number"}},{"id":2841,"name":"maxUploadRetryTime","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the current maximum time in milliseconds to retry an upload if a failure occurs.","text":"#### Example\n\n```js\nconst uploadRetryTime = firebase.storage().maxUploadRetryTime;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1002,"character":22}],"type":{"type":"intrinsic","name":"number"}},{"id":2853,"name":"ref","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2854,"name":"ref","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a new {@link storage.Reference} instance.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('cats.gif');\n```\n"},"parameters":[{"id":2855,"name":"path","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional string pointing to a location on the storage bucket. If no path\nis provided, the returned reference will be the bucket root path.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"Reference","id":2731}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1077,"character":7}]},{"id":2856,"name":"refFromURL","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2857,"name":"refFromURL","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a new {@link storage.Reference} instance from a storage bucket URL.","text":"#### Example\n\n```js\nconst gsUrl = 'gs://react-native-firebase-testing/cats.gif';\nconst httpUrl = 'https://firebasestorage.googleapis.com/v0/b/react-native-firebase-testing.appspot.com/o/cats.gif';\n\nconst refFromGsUrl = firebase.storage().refFromURL(gsUrl);\n// or\nconst refFromHttpUrl = firebase.storage().refFromURL(httpUrl);\n```\n"},"parameters":[{"id":2858,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A storage bucket URL pointing to a single file or location. Must be either a `gs://` url or an `http` url,\ne.g. `gs://assets/logo.png` or `https://firebasestorage.googleapis.com/v0/b/react-native-firebase-testing.appspot.com/o/cats.gif`.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Reference","id":2731}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1096,"character":14}]},{"id":2846,"name":"setMaxDownloadRetryTime","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2847,"name":"setMaxDownloadRetryTime","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the maximum time in milliseconds to retry a download if a failure occurs.","text":"#### Example\n\n```js\nawait firebase.storage().setMaxDownloadRetryTime(25000);\n```\n"},"parameters":[{"id":2848,"name":"time","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new maximum download retry time in milliseconds.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1039,"character":27}]},{"id":2850,"name":"setMaxOperationRetryTime","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2851,"name":"setMaxOperationRetryTime","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the maximum time in milliseconds to retry operations other than upload and download if a failure occurs.","text":"#### Example\n\n```js\nawait firebase.storage().setMaxOperationRetryTime(5000);\n```\n"},"parameters":[{"id":2852,"name":"time","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new maximum operation retry time in milliseconds.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1063,"character":28}]},{"id":2842,"name":"setMaxUploadRetryTime","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2843,"name":"setMaxUploadRetryTime","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the maximum time in milliseconds to retry an upload if a failure occurs.","text":"#### Example\n\n```js\nawait firebase.storage().setMaxUploadRetryTime(25000);\n```\n"},"parameters":[{"id":2844,"name":"time","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The new maximum upload retry time in milliseconds.\n"},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":1015,"character":25}]}],"groups":[{"title":"Properties","kind":1024,"children":[2859,2845,2849,2841]},{"title":"Methods","kind":2048,"children":[2853,2856,2846,2850,2842]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":992,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":2712,"name":"FullMetadata","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The full readable metadata returned by `TaskSnapshot.metadata` or `StorageReference.getMetadata()`."},"children":[{"id":2714,"name":"bucket","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The bucket this storage object is contained in.","text":"#### Example Value\n\n```\ngs://my-project-storage-bucket\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":357,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":2722,"name":"cacheControl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Cache-Control' HTTP header that will be set on the storage object when it's requested.","text":"#### Example 1\n\nTo turn off caching, you can set the following cacheControl value.\n\n```js\n{\n  cacheControl: 'no-store',\n}\n```\n\n#### Example 2\n\nTo aggressively cache an object, e.g. static assets, you can set the following cacheControl value.\n\n```js\n{\n  cacheControl: 'public, max-age=31536000',\n}\n```\n\n[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":272,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"SettableMetadata.cacheControl","id":2703}},{"id":2723,"name":"contentDisposition","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Disposition' HTTP header that will be set on the storage object when it's requested.","text":"[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":279,"character":22}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"SettableMetadata.contentDisposition","id":2704}},{"id":2724,"name":"contentEncoding","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Encoding' HTTP header that will be used on the storage object when it's requested.","text":"[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":286,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"SettableMetadata.contentEncoding","id":2705}},{"id":2725,"name":"contentLanguage","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Language' HTTP header that will be set on the storage object when it's requested.","text":"[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Language)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":293,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"SettableMetadata.contentLanguage","id":2706}},{"id":2726,"name":"contentType","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Type' HTTP header that will be set on the object when it's requested.","text":"This is used to indicate the media type (or MIME type) of the object. When uploading a file\nFirebase Cloud Storage for React Native will attempt to automatically detect this if `contentType`\nis not already set, if it fails to detect a media type it will default to `application/octet-stream`.\n\nFor `DATA_URL` string formats uploaded via `putString` this will also be automatically extracted if available.\n\n#### Example\n\nSetting the content type as JSON, e.g. for when uploading a JSON string via `putString`.\n\n```js\n{\n  contentType: 'application/json',\n}\n```\n\n[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":316,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"SettableMetadata.contentType","id":2707}},{"id":2727,"name":"customMetadata","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Additional user-defined custom metadata for this storage object.","text":"String values only are supported for custom metadata property values.\n\n#### Example\n\nAdding a user controlled NSFW meta data field.\n\n```js\n{\n  customMetadata: {\n    'nsfw': 'true'\n  },\n}\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":334,"character":18}],"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2728,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":2729,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":2730,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":334,"character":20}]}},{"type":"intrinsic","name":"null"}]},"inheritedFrom":{"type":"reference","name":"SettableMetadata.customMetadata","id":2708}},{"id":2715,"name":"fullPath","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The full path to this storage object in its bucket.","text":"#### Example Value\n\n```\ninvertase/logo.png\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":368,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":2716,"name":"generation","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Storage object generation values enable users to uniquely identify data resources, e.g. object versioning.","text":"Read more on generation on the [Google Cloud Storage documentation](https://cloud.google.com/storage/docs/generations-preconditions).\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":375,"character":14}],"type":{"type":"intrinsic","name":"string"}},{"id":2713,"name":"md5Hash","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A Base64-encoded MD5 hash of the storage object being uploaded."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":346,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2717,"name":"metageneration","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Storage object metageneration values enable users to uniquely identify data resources, e.g. object versioning.","text":"Read more on metageneration on the [Google Cloud Storage documentation](https://cloud.google.com/storage/docs/generations-preconditions).\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":382,"character":18}],"type":{"type":"intrinsic","name":"string"}},{"id":2718,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The short name of storage object in its bucket, e.g. it's file name.","text":"#### Example Value\n\n```\nlogo.png\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":393,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":2719,"name":"size","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The size of this storage object in bytes."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":398,"character":8}],"type":{"type":"intrinsic","name":"number"}},{"id":2720,"name":"timeCreated","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A date string representing when this storage object was created.","text":"#### Example Value\n\n```\n2019-05-02T00:34:56.264Z\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":409,"character":15}],"type":{"type":"intrinsic","name":"string"}},{"id":2721,"name":"updated","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A date string representing when this storage object was last updated.","text":"#### Example Value\n\n```\n2019-05-02T00:35:56.264Z\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":420,"character":11}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2714,2722,2723,2724,2725,2726,2727,2715,2716,2713,2717,2718,2719,2720,2721]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":342,"character":31}],"extendedTypes":[{"type":"reference","name":"SettableMetadata","id":2702}]},{"id":2833,"name":"ListOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The options `list()` accepts."},"children":[{"id":2834,"name":"maxResults","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If set, limits the total number of `prefixes` and `items` to return. The default and maximum maxResults is 1000."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":929,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":2835,"name":"pageToken","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The `nextPageToken` from a previous call to `list()`. If provided, listing is resumed from the previous position."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":934,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2834,2835]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":925,"character":30}]},{"id":2836,"name":"ListResult","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Result returned by `list()`."},"children":[{"id":2837,"name":"items","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Objects in this directory. You can call `getMetadate()` and `getDownloadUrl()` on them."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":944,"character":9}],"type":{"type":"array","elementType":{"type":"reference","name":"Reference","id":2731}}},{"id":2838,"name":"nextPageToken","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If set, there might be more results for this list. Use this token to resume the list."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":949,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2839,"name":"prefixes","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"References to prefixes (sub-folders). You can call `list()` on them to get its contents.","text":"Folders are implicit based on '/' in the object paths. For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a') will return '/a/b' as a prefix.\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":956,"character":12}],"type":{"type":"array","elementType":{"type":"reference","name":"Reference","id":2731}}}],"groups":[{"title":"Properties","kind":1024,"children":[2837,2838,2839]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":940,"character":29}]},{"id":2731,"name":"Reference","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a reference to a Google Cloud Storage object in React Native Firebase.","text":"A reference can be used to upload and download storage objects, get/set storage object metadata, retrieve storage object download urls and delete storage objects.\n\n#### Example 1\n\nGet a reference to a specific storage path.\n\n```js\nconst ref = firebase.storage().ref('invertase/logo.png');\n```\n\n#### Example 2\n\nGet a reference to a specific storage path on another bucket in the same firebase project.\n\n```js\nconst ref = firebase.storage().refFromURL('gs://other-bucket/invertase/logo.png');\n```\n"},"children":[{"id":2732,"name":"bucket","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The name of the bucket containing this reference's object."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":448,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":2734,"name":"fullPath","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The full path of this object."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":456,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":2735,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The short name of this object, which is the last component of the full path. For example,\nif fullPath is 'full/path/image.png', name is 'image.png'."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":461,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":2733,"name":"parent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A reference pointing to the parent location of this reference, or null if this reference is the root."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":452,"character":10}],"type":{"type":"union","types":[{"type":"reference","name":"Reference","id":2731},{"type":"intrinsic","name":"null"}]}},{"id":2736,"name":"root","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A reference to the root of this reference's bucket."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":465,"character":8}],"type":{"type":"reference","name":"Reference","id":2731}},{"id":2737,"name":"storage","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The storage service associated with this reference."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":469,"character":11}],"type":{"type":"reference","name":"Module","id":2840}},{"id":2740,"name":"child","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2741,"name":"child","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a reference to a relative path from this reference.","text":"#### Example\n\n```js\nconst parent = firebase.storage().ref('invertase');\nconst ref = parent.child('logo.png');\n```\n"},"parameters":[{"id":2742,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The relative path from this reference. Leading, trailing, and consecutive slashes are removed.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Reference","id":2731}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":495,"character":9}]},{"id":2743,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2744,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Deletes the object at this reference's location.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/logo.png');\nawait ref.delete();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":507,"character":10}]},{"id":2745,"name":"getDownloadURL","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2746,"name":"getDownloadURL","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Fetches a long lived download URL for this object.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/logo.png');\nconst url = await ref.getDownloadURL();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"string"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":519,"character":18}]},{"id":2747,"name":"getMetadata","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2748,"name":"getMetadata","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Fetches metadata for the object at this location, if one exists.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/logo.png');\nconst metadata = await ref.getMetadata();\nconsole.log('Cache control: ', metadata.cacheControl);\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"FullMetadata","id":2712}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":532,"character":15}]},{"id":2749,"name":"list","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2750,"name":"list","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"List items (files) and prefixes (folders) under this storage reference.","text":"List API is only available for Firebase Rules Version 2.\n\nGCS is a key-blob store. Firebase Storage imposes the semantic of '/' delimited folder structure.\nRefer to GCS's List API if you want to learn more.\n\nTo adhere to Firebase Rules's Semantics, Firebase Storage does not support objects whose paths\nend with \"/\" or contain two consecutive \"/\"s. Firebase Storage List API will filter these unsupported objects.\nlist() may fail if there are too many unsupported objects in the bucket.\n\n#### Example\n\n```js\nconst ref = firebase.storage().ref('/');\nconst results = await ref.list({\n  maxResults: 30,\n});\n```\n"},"parameters":[{"id":2751,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional ListOptions interface.\n"},"type":{"type":"reference","name":"ListOptions","id":2833}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"ListResult","id":2836}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":557,"character":8}]},{"id":2752,"name":"listAll","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2753,"name":"listAll","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"List all items (files) and prefixes (folders) under this storage reference.","text":"This is a helper method for calling list() repeatedly until there are no more results. The default pagination size is 1000.\n\nNote: The results may not be consistent if objects are changed while this operation is running.\n\nWarning: `listAll` may potentially consume too many resources if there are too many results.\n\n#### Example\n\n```js\nconst ref = firebase.storage().ref('/');\nconst results = await ref.listAll();\n```\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"ListResult","id":2836}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":575,"character":11}]},{"id":2761,"name":"put","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2762,"name":"put","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Puts data onto the storage bucket.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/new-logo.png');\nconst task = ref.put(BLOB, {\n  cacheControl: 'no-store', // disable caching\n});\n```\n"},"parameters":[{"id":2763,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The data to upload to the storage bucket at the reference location."},"type":{"type":"union","types":[{"type":"reference","name":"Blob"},{"type":"reference","name":"Uint8Array"},{"type":"reference","name":"ArrayBuffer"}]}},{"id":2764,"name":"metadata","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"\n"},"type":{"type":"reference","name":"SettableMetadata","id":2702}}],"type":{"type":"reference","name":"Task","id":2785}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":626,"character":7}]},{"id":2754,"name":"putFile","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2755,"name":"putFile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Puts a file from local disk onto the storage bucket.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/new-logo.png');\nconst path = `${firebase.utils.FilePath.DOCUMENT_DIRECTORY}/new-logo.png`;\nconst task = ref.putFile(path, {\n  cacheControl: 'no-store', // disable caching\n});\n```\n"},"parameters":[{"id":2756,"name":"localFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The local file path to upload to the bucket at the reference location."},"type":{"type":"intrinsic","name":"string"}},{"id":2757,"name":"metadata","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Any additional `SettableMetadata` for this task.\n"},"type":{"type":"reference","name":"SettableMetadata","id":2702}}],"type":{"type":"reference","name":"Task","id":2785}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":593,"character":11}]},{"id":2765,"name":"putString","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2766,"name":"putString","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Puts a string on the storage bucket. Depending on the string type, set a {@link storage.StringFormat} type.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/new-logo.png');\nconst task = ref.putString('PEZvbyBCYXI+', firebase.storage.StringFormat.BASE64, {\n  cacheControl: 'no-store', // disable caching\n});\n```\n"},"parameters":[{"id":2767,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The string data, must match the format provided."},"type":{"type":"intrinsic","name":"string"}},{"id":2768,"name":"format","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The format type of the string, e.g. a Base64 format string."},"type":{"type":"union","types":[{"type":"stringLiteral","value":"raw"},{"type":"stringLiteral","value":"base64"},{"type":"stringLiteral","value":"base64url"},{"type":"stringLiteral","value":"data_url"}]}},{"id":2769,"name":"metadata","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Any additional `SettableMetadata` for this task.\n"},"type":{"type":"reference","name":"SettableMetadata","id":2702}}],"type":{"type":"reference","name":"Task","id":2785}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":644,"character":13}]},{"id":2738,"name":"toString","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2739,"name":"toString","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a gs:// URL for this object in the form `gs://<bucket>/<path>/<to>/<object>`.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/logo.png');\nconsole.log('Full path: ', ref.toString()); // gs://invertase.io/invertase/logo.png\n```\n"},"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":481,"character":12}]},{"id":2770,"name":"updateMetadata","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2771,"name":"updateMetadata","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates the metadata for this reference object on the storage bucket.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref('invertase/nsfw-logo.png');\nconst updatedMetadata = await ref.updateMetadata({\n  customMetadata: {\n    'nsfw': 'true',\n  }\n});\n```\n"},"parameters":[{"id":2772,"name":"metadata","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A `SettableMetadata` instance to update.\n"},"type":{"type":"reference","name":"SettableMetadata","id":2702}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"FullMetadata","id":2712}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":666,"character":18}]},{"id":2758,"name":"writeToFile","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2759,"name":"writeToFile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Downloads a file to the specified local file path on the device.","text":"#### Example\n\nGet a Download Storage task to download a file:\n\n```js\nconst downloadTo = `${firebase.utils.FilePath.DOCUMENT_DIRECTORY}/foobar.json`;\n\nconst task = firebase.storage().ref('/foo/bar.json').writeToFile(downloadTo);\n```"},"parameters":[{"id":2760,"name":"localFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Task","id":2785}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":609,"character":15}]}],"groups":[{"title":"Properties","kind":1024,"children":[2732,2734,2735,2733,2736,2737]},{"title":"Methods","kind":2048,"children":[2740,2743,2745,2747,2749,2752,2761,2754,2765,2738,2770,2758]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":444,"character":28}]},{"id":2702,"name":"SettableMetadata","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An interface representing all the metadata properties that can be set.","text":"This is used in updateMetadata, put, putString & putFile.\n"},"children":[{"id":2703,"name":"cacheControl","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Cache-Control' HTTP header that will be set on the storage object when it's requested.","text":"#### Example 1\n\nTo turn off caching, you can set the following cacheControl value.\n\n```js\n{\n  cacheControl: 'no-store',\n}\n```\n\n#### Example 2\n\nTo aggressively cache an object, e.g. static assets, you can set the following cacheControl value.\n\n```js\n{\n  cacheControl: 'public, max-age=31536000',\n}\n```\n\n[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":272,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2704,"name":"contentDisposition","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Disposition' HTTP header that will be set on the storage object when it's requested.","text":"[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":279,"character":22}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2705,"name":"contentEncoding","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Encoding' HTTP header that will be used on the storage object when it's requested.","text":"[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":286,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2706,"name":"contentLanguage","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Language' HTTP header that will be set on the storage object when it's requested.","text":"[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Language)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":293,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2707,"name":"contentType","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The 'Content-Type' HTTP header that will be set on the object when it's requested.","text":"This is used to indicate the media type (or MIME type) of the object. When uploading a file\nFirebase Cloud Storage for React Native will attempt to automatically detect this if `contentType`\nis not already set, if it fails to detect a media type it will default to `application/octet-stream`.\n\nFor `DATA_URL` string formats uploaded via `putString` this will also be automatically extracted if available.\n\n#### Example\n\nSetting the content type as JSON, e.g. for when uploading a JSON string via `putString`.\n\n```js\n{\n  contentType: 'application/json',\n}\n```\n\n[Learn more about this header on Mozilla.](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type)\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":316,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2708,"name":"customMetadata","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Additional user-defined custom metadata for this storage object.","text":"String values only are supported for custom metadata property values.\n\n#### Example\n\nAdding a user controlled NSFW meta data field.\n\n```js\n{\n  customMetadata: {\n    'nsfw': 'true'\n  },\n}\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":334,"character":18}],"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2709,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":[{"id":2710,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":2711,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":334,"character":20}]}},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2703,2704,2705,2706,2707,2708]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":246,"character":35}],"extendedBy":[{"type":"reference","name":"FullMetadata","id":2712}]},{"id":2698,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Cloud Storage statics.","text":"#### Example\n\n```js\nfirebase.storage;\n```\n"},"children":[{"id":2699,"name":"StringFormat","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Possible string formats used for uploading via `StorageReference.putString()`","text":"#### Example\n\n```js\nfirebase.storage.StringFormat;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":216,"character":16}],"type":{"type":"reference","name":"StringFormat","id":2685}},{"id":2701,"name":"TaskEvent","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An event to subscribe to that is triggered on a Upload or Download task.","text":"#### Example\n\n```js\nfirebase.storage.TaskEvent;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":238,"character":13}],"type":{"type":"reference","name":"TaskEvent","id":2690}},{"id":2700,"name":"TaskState","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A collection of properties that indicates the current tasks state.","text":"#### Example\n\n```js\nfirebase.storage.TaskState;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":227,"character":13}],"type":{"type":"reference","name":"TaskState","id":2692}}],"groups":[{"title":"Properties","kind":1024,"children":[2699,2701,2700]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":206,"character":26}]},{"id":2685,"name":"StringFormat","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Possible string formats used for uploading via `StorageReference.putString()`","text":"```js\nfirebase.storage.StringFormat;\n```\n"},"children":[{"id":2687,"name":"BASE64","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Base64 string format.","text":"Learn more about Base64 [on the Mozilla Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/WindowBase64/Base64_encoding_and_decoding)\n\n#### Usage\n\n```js\nfirebase.storage.StringFormat.BASE64;\n```\n\n#### Example String Format\n\n```js\nconst sampleString = 'PEZvbyBCYXI+';\n```\n\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":103,"character":10}],"type":{"type":"stringLiteral","value":"base64"}},{"id":2688,"name":"BASE64URL","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Base64Url string format.","text":"#### Usage\n\n```js\nfirebase.storage.StringFormat.BASE64URL;\n```\n\n#### Example String Format\n\n```js\nconst sampleString = 'PEZvbyBCYXI-';\n```\n\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":121,"character":13}],"type":{"type":"stringLiteral","value":"base64url"}},{"id":2689,"name":"DATA_URL","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Data URL string format.","text":"#### Usage\n\n```js\nfirebase.storage.StringFormat.DATA_URL;\n```\n\n#### Example String Format\n\n```js\nconst sampleString = 'data:text/plain;base64,PEZvbyBCYXI+';\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":138,"character":12}],"type":{"type":"stringLiteral","value":"data_url"}},{"id":2686,"name":"RAW","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Raw string format.","text":"#### Usage\n\n```js\nfirebase.storage.StringFormat.RAW;\n```\n\n#### Example String Format\n\n```js\nconst sampleString = '<Foo Bar>';\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":83,"character":7}],"type":{"type":"stringLiteral","value":"raw"}}],"groups":[{"title":"Properties","kind":1024,"children":[2687,2688,2689,2686]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":67,"character":31}]},{"id":2785,"name":"Task","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Storage Task used for Uploading or Downloading files.","text":"#### Example 1\n\nGet a Upload Storage task to upload a string:\n\n```js\nconst string = '{ \"foo\": 1 }';\nconst task = firebase\n .storage()\n .ref('/foo/bar.json')\n .putString(string);\n```\n\n#### Example 2\n\nGet a Download Storage task to download a file:\n\n```js\nconst downloadTo = `${firebase.utils.FilePath.DOCUMENT_DIRECTORY}/bar.json`;\n\nconst task = firebase\n .storage()\n .ref('/foo/bar.json')\n .writeToFile(downloadTo);\n```\n"},"children":[{"id":2786,"name":"snapshot","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Initial state of Task.snapshot is `null`. Once uploading begins, it updates to a `TaskSnapshot` object."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":744,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"reference","name":"TaskSnapshot","id":2825}]}},{"id":2791,"name":"cancel","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2792,"name":"cancel","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Cancel the current Download or Upload task.","text":"#### Example\n\nCancel a task inside a state changed listener:\n\n```js\ntask.on('state_changed', taskSnapshot => {\n  console.log('Cancelling my task!');\n  task.cancel();\n});\n```\n\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"boolean"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":801,"character":10}]},{"id":2819,"name":"catch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2820,"name":"catch","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2821,"name":"onRejected","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":2822,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2823,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2824,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"NativeFirebaseError","id":2}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":848,"character":21}]}}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"any"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":848,"character":9}]},{"id":2793,"name":"on","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2794,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Task event handler called when state has changed on the task.","text":"#### Example\n\n```js\nconst task = firebase\n .storage()\n .ref('/foo/bar.json')\n .writeToFile(downloadTo);\n\ntask.on('state_changed', (taskSnapshot) => {\n  console.log(taskSnapshot.state);\n});\n\ntask.then(() => {]\n  console.log('Task complete');\n})\n.catch((error) => {\n  console.error(error.message);\n});\n```\n"},"parameters":[{"id":2795,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The event name to handle, always `state_changed`."},"type":{"type":"stringLiteral","value":"state_changed"}},{"id":2796,"name":"nextOrObserver","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The optional event observer function."},"type":{"type":"union","types":[{"type":"reference","name":"TaskSnapshotObserver","id":2773},{"type":"intrinsic","name":"null"},{"type":"reflection","declaration":{"id":2797,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2798,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2799,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"TaskSnapshot","id":2825}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":833,"character":52}]}}]}},{"id":2800,"name":"error","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional JavaScript error handler."},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2801,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2802,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2803,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"NativeFirebaseError","id":2}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":834,"character":13}]}},{"type":"intrinsic","name":"null"}]}},{"id":2804,"name":"complete","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional complete handler function.\n"},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2805,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2806,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":835,"character":16}]}},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reflection","declaration":{"id":2807,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2808,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":836,"character":6}]}}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":831,"character":6}]},{"id":2787,"name":"pause","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2788,"name":"pause","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Pause the current Download or Upload task.","text":"#### Example\n\nPause a running task inside a state changed listener:\n\n```js\ntask.on('state_changed', taskSnapshot => {\n  if (taskSnapshot.state === firebase.storage.TaskState.RUNNING) {\n    console.log('Pausing my task!');\n    task.pause();\n  }\n});\n```\n\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"boolean"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":763,"character":9}]},{"id":2789,"name":"resume","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2790,"name":"resume","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Resume the current Download or Upload task.","text":"#### Example\n\nResume a previously paused task inside a state changed listener:\n\n```js\ntask.on('state_changed', taskSnapshot => {\n  // ... pause me ...\n  if (taskSnapshot.state === firebase.storage.TaskState.PAUSED) {\n    console.log('Resuming my task!');\n    task.resume();\n  }\n});\n```\n\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"boolean"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":783,"character":10}]},{"id":2809,"name":"then","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2810,"name":"then","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2811,"name":"onFulfilled","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2812,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2813,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2814,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"TaskSnapshot","id":2825}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":844,"character":19}]}},{"type":"intrinsic","name":"null"}]}},{"id":2815,"name":"onRejected","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2816,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2817,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2818,"name":"a","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"NativeFirebaseError","id":2}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":845,"character":18}]}},{"type":"intrinsic","name":"null"}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"any"}]}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":843,"character":8}]}],"groups":[{"title":"Properties","kind":1024,"children":[2786]},{"title":"Methods","kind":2048,"children":[2791,2819,2793,2787,2789,2809]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":740,"character":23}]},{"id":2690,"name":"TaskEvent","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An event to subscribe to that is triggered on a Upload or Download task.","text":"Event subscription is created via `StorageTask.on()`.\n\n```js\nfirebase.storage.TaskEvent;\n```\n"},"children":[{"id":2691,"name":"STATE_CHANGED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An event that indicates that the tasks state has changed.","text":"```js\nfirebase.storage.TaskEvent.STATE_CHANGED;\n```\n"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":158,"character":17}],"type":{"type":"stringLiteral","value":"state_changed"}}],"groups":[{"title":"Properties","kind":1024,"children":[2691]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":150,"character":28}]},{"id":2825,"name":"TaskSnapshot","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A TaskSnapshot provides information about a storage tasks state.","text":"#### Example 1\n\n```js\nfirebase\n  .storage()\n  .ref('/foo/bar.json')\n  .putString(JSON.stringify({ foo: 'bar' }))\n  .then((taskSnapshot) => {\n    if (taskSnapshot.state === firebase.storage.TaskState.SUCCESS) {\n      console.log('Total bytes uploaded: ', taskSnapshot.totalBytes);\n    }\n  });\n```\n\n#### Example 2\n\n```js\nconst task = firebase\n  .storage()\n  .ref('/foo/bar.json')\n  .putString(JSON.stringify({ foo: 'bar' }));\n\ntask.on('state_changed', taskSnapshot => {\n  if (taskSnapshot.state === firebase.storage.TaskState.PAUSED) {\n    console.log('Resuming my task!');\n    task.resume();\n  }\n});\n```\n"},"children":[{"id":2826,"name":"bytesTransferred","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The number of bytes currently transferred."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":888,"character":20}],"type":{"type":"intrinsic","name":"number"}},{"id":2832,"name":"error","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If the {@link storage.TaskSnapshot#state} is `error`, returns a JavaScript error of the\ncurrent task snapshot."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":919,"character":9}],"type":{"type":"reference","name":"NativeFirebaseError","id":2}},{"id":2827,"name":"metadata","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The metadata of the tasks via a {@link storage.FullMetadata} interface."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":893,"character":12}],"type":{"type":"reference","name":"FullMetadata","id":2712}},{"id":2828,"name":"ref","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The {@link storage.Reference} of the task."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":898,"character":7}],"type":{"type":"reference","name":"Reference","id":2731}},{"id":2829,"name":"state","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current state of the task snapshot."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":903,"character":9}],"type":{"type":"union","types":[{"type":"stringLiteral","value":"cancelled"},{"type":"stringLiteral","value":"error"},{"type":"stringLiteral","value":"paused"},{"type":"stringLiteral","value":"running"},{"type":"stringLiteral","value":"success"}]}},{"id":2830,"name":"task","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The parent {@link storage.Task} of this snapshot."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":908,"character":8}],"type":{"type":"reference","name":"Task","id":2785}},{"id":2831,"name":"totalBytes","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The total amount of bytes for this task."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":913,"character":14}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[2826,2832,2827,2828,2829,2830,2831]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":884,"character":31}]},{"id":2773,"name":"TaskSnapshotObserver","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The snapshot observer returned from a {@link storage.Task#on} listener.","text":"#### Example\n\n```js\nconst ref = firebase.storage().ref(...);\nconst task = ref.put(...)\n\ntask.on('state_changed', {\n  next(taskSnapshot) {\n    console.log(taskSnapshot.state);\n  },\n  error(error) {\n    console.error(error.message);\n  },\n  complete() {\n    console.log('Task complete');\n  },\n})\n```\n"},"children":[{"id":2782,"name":"complete","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Called when the task has completed successfully."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":709,"character":12}],"type":{"type":"reflection","declaration":{"id":2783,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2784,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":709,"character":13}]}}},{"id":2778,"name":"error","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Called when the task errors."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":704,"character":9}],"type":{"type":"reflection","declaration":{"id":2779,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"comment":{"text":"A JavaScript error.\n"},"signatures":[{"id":2780,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"comment":{"text":"A JavaScript error.\n"},"parameters":[{"id":2781,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"NativeFirebaseError","id":2}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":704,"character":10}]}}},{"id":2774,"name":"next","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Called when the task state changes.","tags":[{"tag":"param","text":"A `TaskSnapshot` for the event.\n","param":"taskSnapshot"}]},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":697,"character":8}],"type":{"type":"reflection","declaration":{"id":2775,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":2776,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":2777,"name":"taskSnapshot","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"TaskSnapshot","id":2825}}],"type":{"type":"intrinsic","name":"void"}}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":697,"character":9}]}}}],"groups":[{"title":"Properties","kind":1024,"children":[2782,2778,2774]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":691,"character":39}]},{"id":2692,"name":"TaskState","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A collection of properties that indicates the current tasks state.","text":"An event subscription is created via `StorageTask.on()`.\n\n```js\nfirebase.storage.TaskEvent;\n```\n"},"children":[{"id":2693,"name":"CANCELLED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Task has been cancelled by the user."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":174,"character":13}],"type":{"type":"stringLiteral","value":"cancelled"}},{"id":2694,"name":"ERROR","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An Error occurred, see TaskSnapshot.error for details."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":179,"character":9}],"type":{"type":"stringLiteral","value":"error"}},{"id":2695,"name":"PAUSED","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Task has been paused. Resume the task via `StorageTask.resume()`."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":184,"character":10}],"type":{"type":"stringLiteral","value":"paused"}},{"id":2696,"name":"RUNNING","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Task is running. Pause the task via `StorageTask.pause()`"},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":189,"character":11}],"type":{"type":"stringLiteral","value":"running"}},{"id":2697,"name":"SUCCESS","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Task has completed successfully."},"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":194,"character":11}],"type":{"type":"stringLiteral","value":"success"}}],"groups":[{"title":"Properties","kind":1024,"children":[2693,2694,2695,2696,2697]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":170,"character":28}]}],"groups":[{"title":"Classes","kind":128,"children":[2840]},{"title":"Interfaces","kind":256,"children":[2712,2833,2836,2731,2702,2698,2685,2785,2690,2825,2773,2692]}],"sources":[{"fileName":"packages/storage/lib/index.d.ts","line":56,"character":37}]},{"id":2286,"name":"FirebaseVisionTypes","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase ML Kit package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `ml-vision` package:\n\n```js\nimport { firebase } from '@react-native-firebase/ml-vision';\n\n// firebase.vision().X\n```\n\n#### Example 2\n\nUsing the default export from the `ml-vision` package:\n\n```js\nimport vision from '@react-native-firebase/ml-vision';\n\n// vision().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/ml-vision';\n\n// firebase.vision().X\n```\n","tags":[{"tag":"firebase","text":"ml-vision\n"}]},"children":[{"id":2320,"name":"VisionCloudLandmarkRecognizerModelType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Model types for cloud landmark recognition."},"children":[{"id":2322,"name":"LATEST_MODEL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Latest model would be used."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":304,"character":16}],"defaultValue":"2"},{"id":2321,"name":"STABLE_MODEL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Stable model would be used."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":299,"character":16}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2322,2321]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":295,"character":52}]},{"id":2332,"name":"VisionCloudTextRecognizerModelType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The cloud model type used for in VisionCloudTextRecognizerOptions & VisionCloudDocumentTextRecognizerOptions","text":"Defaults to `SPARSE_MODEL`\n"},"children":[{"id":2334,"name":"DENSE_MODEL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Sparse model type. It is more suitable for sparse text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":450,"character":15}],"defaultValue":"2"},{"id":2333,"name":"SPARSE_MODEL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Dense model type. It is more suitable for well-formatted dense text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":446,"character":16}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2334,2333]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":442,"character":48}]},{"id":2377,"name":"VisionDocumentTextRecognizedBreakType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Enum representing the detected break type."},"children":[{"id":2378,"name":"EOL_SURE_SPACE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Line-wrapping break."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":597,"character":18}],"defaultValue":"3"},{"id":2379,"name":"HYPHEN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":602,"character":10}],"defaultValue":"4"},{"id":2380,"name":"LINE_BREAK","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Line break that ends a paragraph."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":607,"character":14}],"defaultValue":"5"},{"id":2381,"name":"SPACE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Regular space."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":612,"character":9}],"defaultValue":"1"},{"id":2382,"name":"SURE_SPACE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Sure space (very wide)."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":617,"character":14}],"defaultValue":"2"},{"id":2383,"name":"UNKNOWN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Unknown break label type."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":622,"character":11}],"defaultValue":"0"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2378,2379,2380,2381,2382,2383]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":593,"character":51}]},{"id":2452,"name":"VisionFaceContourType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Countour type for a face."},"children":[{"id":2453,"name":"ALL_POINTS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"All points of a face contour."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":920,"character":14}],"defaultValue":"1"},{"id":2454,"name":"FACE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The outline of the subject's face."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":925,"character":8}],"defaultValue":"2"},{"id":2455,"name":"LEFT_EYE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The outline of the subject's left eye cavity."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":930,"character":12}],"defaultValue":"7"},{"id":2456,"name":"LEFT_EYEBROW_BOTTOM","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The bottom outline of the subject's left eyebrow."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":935,"character":23}],"defaultValue":"4"},{"id":2457,"name":"LEFT_EYEBROW_TOP","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The top outline of the subject's left eyebrow."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":940,"character":20}],"defaultValue":"3"},{"id":2458,"name":"LOWER_LIP_BOTTOM","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The bottom outline of the subject's lower lip."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":945,"character":20}],"defaultValue":"12"},{"id":2459,"name":"LOWER_LIP_TOP","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The top outline of the subject's lower lip."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":950,"character":17}],"defaultValue":"11"},{"id":2460,"name":"NOSE_BOTTOM","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The outline of the subject's nose bridge."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":955,"character":15}],"defaultValue":"14"},{"id":2461,"name":"NOSE_BRIDGE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The outline of the subject's nose bridge."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":960,"character":15}],"defaultValue":"13"},{"id":2462,"name":"RIGHT_EYE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The outline of the subject's right eye cavity."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":965,"character":13}],"defaultValue":"8"},{"id":2463,"name":"RIGHT_EYEBROW_BOTTOM","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The bottom outline of the subject's right eyebrow."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":970,"character":24}],"defaultValue":"6"},{"id":2464,"name":"RIGHT_EYEBROW_TOP","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The top outline of the subject's right eyebrow."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":975,"character":21}],"defaultValue":"5"},{"id":2465,"name":"UPPER_LIP_BOTTOM","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The bottom outline of the subject's upper lip."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":980,"character":20}],"defaultValue":"10"},{"id":2466,"name":"UPPER_LIP_TOP","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The top outline of the subject's upper lip."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":985,"character":17}],"defaultValue":"9"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2453,2454,2455,2456,2457,2458,2459,2460,2461,2462,2463,2464,2465,2466]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":916,"character":35}]},{"id":2335,"name":"VisionFaceDetectorClassificationMode","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Indicates whether to run additional classifiers for characterizing attributes such as \"smiling\" and \"eyes open\"."},"children":[{"id":2337,"name":"ALL_CLASSIFICATIONS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Enables collection of classifier information."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":465,"character":23}],"defaultValue":"2"},{"id":2336,"name":"NO_CLASSIFICATIONS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Disables collection of classifier information."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":460,"character":22}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2337,2336]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":456,"character":50}]},{"id":2338,"name":"VisionFaceDetectorContourMode","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Sets whether to detect contours or not. Processing time increases as the number of contours to search for increases,\nso detecting all contours will increase the overall detection time."},"children":[{"id":2340,"name":"ALL_CONTOURS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Enables collection of contour information."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":481,"character":16}],"defaultValue":"2"},{"id":2339,"name":"NO_CONTOURS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Disables collection of contour information."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":476,"character":15}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2340,2339]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":472,"character":43}]},{"id":2341,"name":"VisionFaceDetectorLandmarkMode","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Sets whether to detect no landmarks or all landmarks. Processing time increases as the number of landmarks to\nsearch for increases, so detecting all landmarks will increase the overall detection time. Detecting\nlandmarks can improve pose estimation."},"children":[{"id":2343,"name":"ALL_LANDMARKS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Enables collection of landmark information."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":498,"character":17}],"defaultValue":"2"},{"id":2342,"name":"NO_LANDMARKS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Disables collection of landmark information."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":493,"character":16}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2343,2342]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":489,"character":44}]},{"id":2344,"name":"VisionFaceDetectorPerformanceMode","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Extended option for controlling additional accuracy / speed trade-offs in performing face detection. In general,\nchoosing the more accurate mode will generally result in longer runtime, whereas choosing the faster\nmode will generally result in detecting fewer faces."},"children":[{"id":2346,"name":"ACCURATE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Indicates a preference for accuracy in extended settings that may make an accuracy vs. speed trade-off.\nThis will tend to detect more faces and may be more precise in determining values such as position, at the cost\nof speed."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":518,"character":12}],"defaultValue":"2"},{"id":2345,"name":"FAST","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Indicates a preference for speed in extended settings that may make an accuracy vs. speed trade-off. This will\ntend to detect fewer faces and may be less precise in determining values such as position, but will run faster."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":511,"character":8}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2346,2345]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":506,"character":47}]},{"id":2438,"name":"VisionFaceLandmarkType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Landmark types for a face."},"children":[{"id":2439,"name":"LEFT_CHEEK","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The midpoint between the subject's left mouth corner and the outer corner of the subject's left eye."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":847,"character":14}],"defaultValue":"1"},{"id":2440,"name":"LEFT_EAR","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The midpoint of the subject's left ear tip and left ear lobe."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":852,"character":12}],"defaultValue":"3"},{"id":2441,"name":"LEFT_EYE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The center of the subject's left eye cavity."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":857,"character":12}],"defaultValue":"4"},{"id":2442,"name":"MOUTH_BOTTOM","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The center of the subject's bottom lip."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":862,"character":16}],"defaultValue":"0"},{"id":2443,"name":"MOUTH_LEFT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The subject's left mouth corner where the lips meet."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":867,"character":14}],"defaultValue":"5"},{"id":2444,"name":"MOUTH_RIGHT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The subject's right mouth corner where the lips meet."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":872,"character":15}],"defaultValue":"11"},{"id":2445,"name":"NOSE_BASE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The midpoint between the subject's nostrils where the nose meets the face."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":877,"character":13}],"defaultValue":"6"},{"id":2446,"name":"RIGHT_CHEEK","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The midpoint between the subject's right mouth corner and the outer corner of the subject's right eye."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":882,"character":15}],"defaultValue":"7"},{"id":2447,"name":"RIGHT_EAR","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The midpoint of the subject's right ear tip and right ear lobe."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":887,"character":13}],"defaultValue":"9"},{"id":2448,"name":"RIGHT_EYE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"The center of the subject's right eye cavity."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":892,"character":13}],"defaultValue":"10"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2439,2440,2441,2442,2443,2444,2445,2446,2447,2448]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":843,"character":36}]},{"id":2473,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The Firebase ML Kit service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the ML Kit service for the default app:\n\n```js\nconst defaultAppMLKit = firebase.vision();\n```\n"},"children":[{"id":2505,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":2501,"name":"barcodeDetectorProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2502,"name":"barcodeDetectorProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an array of barcodes (as `VisionBarcode`) detected for a local image file path.","text":"Barcode detection is done locally on device.\n\n#### Example 1\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo);\n}\n```\n\n#### Example 2\n\nProcess image with custom `VisionBarcodeDetectorOptions`.\n\n```js\nimport vision, { VisionBarcodeFormat, VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath, {\n  barcodeFormats: [VisionBarcodeFormat.QR_CODE]\n});\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo);\n}\n```\n"},"parameters":[{"id":2503,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local image file path."},"type":{"type":"intrinsic","name":"string"}},{"id":2504,"name":"barcodeDetectorOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"Optional instance of `VisionBarcodeDetectorOptions`.\n"},"type":{"type":"reference","name":"VisionBarcodeDetectorOptions","id":2236}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"VisionBarcode","id":2161}}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1171,"character":31}]},{"id":2485,"name":"cloudDocumentTextRecognizerProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2486,"name":"cloudDocumentTextRecognizerProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detect text within a document using a local image file from the cloud (Firebase) model."},"parameters":[{"id":2487,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local path to an image on the device."},"type":{"type":"intrinsic","name":"string"}},{"id":2488,"name":"cloudDocumentTextRecognizerOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An instance of `VisionCloudDocumentTextRecognizerOptions`.\n"},"type":{"type":"reference","name":"VisionCloudDocumentTextRecognizerOptions","id":2328}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"VisionDocumentText","id":2393}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1078,"character":43}]},{"id":2497,"name":"cloudImageLabelerProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2498,"name":"cloudImageLabelerProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an array of labels (as `VisionImageLabel`) of a given local image file path. Label detection is done\non cloud (Firebase), resulting in slower results but more descriptive.","text":"#### Example\n\n```js\nconst labels = await firebase.vision().cloudImageLabelerProcessImage(filePath, {\n  confidenceThreshold: 0.8,\n});\n```\n"},"parameters":[{"id":2499,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local image file path."},"type":{"type":"intrinsic","name":"string"}},{"id":2500,"name":"cloudImageLabelerOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional instance of `VisionCloudImageLabelerOptions`.\n"},"type":{"type":"reference","name":"VisionCloudImageLabelerOptions","id":2311}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"VisionImageLabel","id":2422}}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1130,"character":33}]},{"id":2489,"name":"cloudLandmarkRecognizerProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2490,"name":"cloudLandmarkRecognizerProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an array of landmarks (as `VisionLandmark`) of a given local image file path. Landmark detection\nis done on cloud (Firebase)."},"parameters":[{"id":2491,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local image file path."},"type":{"type":"intrinsic","name":"string"}},{"id":2492,"name":"cloudLandmarkRecognizerOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional instance of `VisionCloudLandmarkRecognizerOptions`.\n"},"type":{"type":"reference","name":"VisionCloudLandmarkRecognizerOptions","id":2315}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"VisionLandmark","id":2467}}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1090,"character":39}]},{"id":2481,"name":"cloudTextRecognizerProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2482,"name":"cloudTextRecognizerProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detect text from a local image file using the cloud (Firebase) model."},"parameters":[{"id":2483,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local path to an image on the device."},"type":{"type":"intrinsic","name":"string"}},{"id":2484,"name":"cloudTextRecognizerOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An instance of `VisionCloudTextRecognizerOptions`.\n"},"type":{"type":"reference","name":"VisionCloudTextRecognizerOptions","id":2323}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"VisionText","id":2347}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1067,"character":35}]},{"id":2474,"name":"faceDetectorProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2475,"name":"faceDetectorProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detects faces from a local image file."},"parameters":[{"id":2476,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local path to an image on the device."},"type":{"type":"intrinsic","name":"string"}},{"id":2477,"name":"faceDetectorOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional instance of `VisionFaceDetectorOptions`.\n"},"type":{"type":"reference","name":"VisionFaceDetectorOptions","id":2303}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"VisionFace","id":2426}}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1049,"character":28}]},{"id":2493,"name":"imageLabelerProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2494,"name":"imageLabelerProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns an array of labels (as `VisionImageLabel`) of a given local image file path. Label detection is done\non device, resulting in faster results but less descriptive.","text":"#### Example\n\n```js\nconst labels = await firebase.vision().imageLabelerProcessImage(filePath, {\n  confidenceThreshold: 0.8,\n});\n```\n"},"parameters":[{"id":2495,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local image file path."},"type":{"type":"intrinsic","name":"string"}},{"id":2496,"name":"imageLabelerOptions","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An optional instance of `VisionImageLabelerOptions`.\n"},"type":{"type":"reference","name":"VisionImageLabelerOptions","id":2309}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"array","elementType":{"type":"reference","name":"VisionImageLabel","id":2422}}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1110,"character":28}]},{"id":2478,"name":"textRecognizerProcessImage","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":2479,"name":"textRecognizerProcessImage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Detect text from a local image file using the on-device model."},"parameters":[{"id":2480,"name":"imageFilePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A local path to an image on the device.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"VisionText","id":2347}]}}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1059,"character":30}]}],"groups":[{"title":"Properties","kind":1024,"children":[2505]},{"title":"Methods","kind":2048,"children":[2501,2485,2497,2489,2481,2474,2493,2478]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1042,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":2287,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":2299,"name":"VisionBarcodeAddressType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":71,"character":28}],"type":{"type":"intrinsic","name":"any"}},{"id":2300,"name":"VisionBarcodeEmailType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":72,"character":26}],"type":{"type":"intrinsic","name":"any"}},{"id":2297,"name":"VisionBarcodeFormat","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":69,"character":23}],"type":{"type":"intrinsic","name":"any"}},{"id":2301,"name":"VisionBarcodePhoneType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":73,"character":26}],"type":{"type":"intrinsic","name":"any"}},{"id":2298,"name":"VisionBarcodeValueType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":70,"character":26}],"type":{"type":"intrinsic","name":"any"}},{"id":2302,"name":"VisionBarcodeWifiEncryptionType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":74,"character":35}],"type":{"type":"intrinsic","name":"any"}},{"id":2295,"name":"VisionCloudLandmarkRecognizerModelType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":67,"character":42}],"type":{"type":"reference","name":"VisionCloudLandmarkRecognizerModelType","id":2320}},{"id":2288,"name":"VisionCloudTextRecognizerModelType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":60,"character":38}],"type":{"type":"reference","name":"VisionCloudTextRecognizerModelType","id":2332}},{"id":2296,"name":"VisionDocumentTextRecognizedBreakType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":68,"character":41}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreakType","id":2377}},{"id":2294,"name":"VisionFaceContourType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":66,"character":25}],"type":{"type":"reference","name":"VisionFaceContourType","id":2452}},{"id":2289,"name":"VisionFaceDetectorClassificationMode","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":61,"character":40}],"type":{"type":"reference","name":"VisionFaceDetectorClassificationMode","id":2335}},{"id":2290,"name":"VisionFaceDetectorContourMode","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":62,"character":33}],"type":{"type":"reference","name":"VisionFaceDetectorContourMode","id":2338}},{"id":2291,"name":"VisionFaceDetectorLandmarkMode","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":63,"character":34}],"type":{"type":"reference","name":"VisionFaceDetectorLandmarkMode","id":2341}},{"id":2292,"name":"VisionFaceDetectorPerformanceMode","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":64,"character":37}],"type":{"type":"reference","name":"VisionFaceDetectorPerformanceMode","id":2344}},{"id":2293,"name":"VisionFaceLandmarkType","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":65,"character":26}],"type":{"type":"reference","name":"VisionFaceLandmarkType","id":2438}}],"groups":[{"title":"Properties","kind":1024,"children":[2299,2300,2297,2301,2298,2302,2295,2288,2296,2294,2289,2290,2291,2292,2293]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":59,"character":26}]},{"id":2328,"name":"VisionCloudDocumentTextRecognizerOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Options for the cloud document text recognizer."},"children":[{"id":2331,"name":"apiKeyOverride","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"API key to use for Cloud Vision API. If not set, the default API key from `firebase.app()` will be used.","text":"#### Example\n\n```js\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  apiKeyOverride: 'xyz123',\n});\n```\n","tags":[{"tag":"ios","text":"\n"}]},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":434,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2329,"name":"enforceCertFingerprintMatch","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Only allow registered application instances with matching certificate fingerprint to use Cloud Vision API.","text":"> Do not set this for debug build if you use simulators to test.\n\n#### Example\n\n```js\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  enforceCertFingerprintMatch: true,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":401,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2330,"name":"languageHints","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets language hints. In most cases, not setting this yields the best results since it enables automatic language\ndetection. For languages based on the Latin alphabet, setting language hints is not needed. In rare cases, when\nthe language of the text in the image is known, setting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong).","text":"Each language code must be a BCP-47 identifier. See [Google Cloud OCR Language Support](https://cloud.google.com/vision/docs/languages) for more information.\n\n#### Example\n\n```js\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  languageHints: ['fr', 'de'],\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":419,"character":17}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"groups":[{"title":"Properties","kind":1024,"children":[2331,2329,2330]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":387,"character":59}]},{"id":2311,"name":"VisionCloudImageLabelerOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Options for cloud image labeler. Confidence threshold could be provided for the label detection.","text":"For example, if the confidence threshold is set to 0.7, only labels with confidence >= 0.7 would be returned. The default threshold is 0.5.\n\nNote: at most 20 labels will be returned for cloud image labeler.\n"},"children":[{"id":2314,"name":"apiKeyOverride","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"API key to use for Cloud Vision API. If not set, the default API key from `firebase.app()` will be used.","text":"#### Example\n\n```js\nawait firebase.vision().cloudImageLabelerProcessImage(filePath, {\n  apiKeyOverride: 'xyz123',\n});\n```\n","tags":[{"tag":"ios","text":"\n"}]},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":254,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2313,"name":"confidenceThreshold","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets confidence threshold in the range of [0.0 - 1.0] of detected labels. Only labels detected with confidence higher than this threshold are returned.","text":"Defaults to 0.5.\n\n#### Example\n\n```js\nawait firebase.vision().cloudImageLabelerProcessImage(filePath, {\n  confidenceThreshold: 0.8,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":239,"character":23}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":2312,"name":"enforceCertFingerprintMatch","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Only allow registered application instances with matching certificate fingerprint to use Cloud Vision API.","text":"> Do not set this for debug build if you use simulators to test.\n\n#### Example\n\n```js\nawait firebase.vision().cloudImageLabelerProcessImage(filePath, {\n  enforceCertFingerprintMatch: true,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":224,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2314,2313,2312]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":210,"character":49}]},{"id":2315,"name":"VisionCloudLandmarkRecognizerOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Detector for finding popular natural and man-made structures within an image."},"children":[{"id":2319,"name":"apiKeyOverride","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"API key to use for Cloud Vision API. If not set, the default API key from `firebase.app()` will be used.","tags":[{"tag":"ios","text":"\n"}]},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":289,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2316,"name":"enforceCertFingerprintMatch","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Only allow registered application instances with matching certificate fingerprint to use Cloud Vision API.","text":"> Do not set this for debug build if you use simulators to test.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":266,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2317,"name":"maxResults","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the maximum number of results of this type.","text":"Defaults to 10.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":273,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":2318,"name":"modelType","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets model type for the detection.","text":"Defaults to `VisionCloudLandmarkRecognizerModelType.STABLE_MODEL`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":280,"character":13}],"type":{"type":"union","types":[{"type":"reference","name":"STABLE_MODEL","id":2321},{"type":"reference","name":"LATEST_MODEL","id":2322}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2319,2316,2317,2318]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":260,"character":55}]},{"id":2323,"name":"VisionCloudTextRecognizerOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Options for cloud text recognizer."},"children":[{"id":2327,"name":"apiKeyOverride","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"API key to use for Cloud Vision API. If not set, the default API key from `firebase.app()` will be used.","text":"#### Example\n\n```js\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  apiKeyOverride: 'xyz123',\n});\n```\n","tags":[{"tag":"ios","text":"\n"}]},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":381,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2324,"name":"enforceCertFingerprintMatch","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Only allow registered application instances with matching certificate fingerprint to use Cloud Vision API.","text":"> Do not set this for debug build if you use simulators to test.\n\n#### Example\n\n```js\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  enforceCertFingerprintMatch: true,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":324,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2326,"name":"languageHints","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets language hints. In most cases, not setting this yields the best results since it enables automatic language\ndetection. For languages based on the Latin alphabet, setting language hints is not needed. In rare cases, when\nthe language of the text in the image is known, setting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong).","text":"Each language code must be a BCP-47 identifier. See [Google Cloud OCR Language Support](https://cloud.google.com/vision/docs/languages) for more information.\n\n#### Example\n\n```js\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  languageHints: ['fr', 'de'],\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":366,"character":17}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2325,"name":"modelType","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets model type for cloud text recognition. The two models SPARSE_MODEL and DENSE_MODEL handle different text densities in an image.","text":"See `VisionCloudTextRecognizerModelType` for types.\n\nDefaults to `VisionCloudTextRecognizerModelType.SPARSE_MODEL`.\n\n#### Example\n\n```js\nimport {\n  firebase,\n  VisionCloudTextRecognizerModelType,\n} from '@react-native-firebase/ml-vision';\n\nawait firebase.vision().cloudTextRecognizerProcessImage(filePath, {\n  modelType: VisionCloudTextRecognizerModelType.DENSE_MODEL,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":346,"character":13}],"type":{"type":"union","types":[{"type":"reference","name":"SPARSE_MODEL","id":2333},{"type":"reference","name":"DENSE_MODEL","id":2334}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2327,2324,2326,2325]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":310,"character":51}]},{"id":2393,"name":"VisionDocumentText","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A hierarchical representation of document text recognized in an image."},"children":[{"id":2394,"name":"blocks","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an array `VisionTextBlock`, which is a block of text that can be further decomposed to an array of `VisionDocumentTextParagraph`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":678,"character":10}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionDocumentTextBlock","id":2350}},"overwrites":{"type":"reference","name":"VisionText.blocks","id":2349}},{"id":2395,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Retrieve the recognized text as a string."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":544,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionText.text","id":2348}}],"groups":[{"title":"Properties","kind":1024,"children":[2394,2395]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":674,"character":37}],"extendedTypes":[{"type":"reference","name":"VisionText","id":2347}]},{"id":2387,"name":"VisionDocumentTextBase","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A shared type that all VisionDocumentText components inherit from"},"children":[{"id":2391,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":663,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506}},{"id":2389,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":651,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]}},{"id":2392,"name":"recognizedBreak","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized break - the detected start or end of a structural component."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":668,"character":19}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreak","id":2384}},{"id":2390,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":658,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}}},{"id":2388,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":646,"character":8}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2391,2389,2392,2390,2388]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":642,"character":41}],"extendedBy":[{"type":"reference","name":"VisionDocumentTextBlock","id":2350},{"type":"reference","name":"VisionDocumentTextParagraph","id":2357},{"type":"reference","name":"VisionDocumentTextWord","id":2364},{"type":"reference","name":"VisionDocumentTextSymbol","id":2371}]},{"id":2350,"name":"VisionDocumentTextBlock","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a block of text."},"children":[{"id":2355,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":663,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.boundingBox","id":2391}},{"id":2353,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":651,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.confidence","id":2389}},{"id":2351,"name":"paragraphs","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an Array of `VisionDocumentTextParagraph`s that make up this block."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":559,"character":14}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionDocumentTextParagraph","id":2357}}},{"id":2356,"name":"recognizedBreak","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized break - the detected start or end of a structural component."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":668,"character":19}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreak","id":2384},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedBreak","id":2392}},{"id":2354,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":658,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedLanguages","id":2390}},{"id":2352,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":646,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.text","id":2388}}],"groups":[{"title":"Properties","kind":1024,"children":[2355,2353,2351,2356,2354,2352]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":555,"character":42}],"extendedTypes":[{"type":"reference","name":"VisionDocumentTextBase","id":2387}]},{"id":2357,"name":"VisionDocumentTextParagraph","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A structural unit of text representing a number of words in certain order."},"children":[{"id":2362,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":663,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.boundingBox","id":2391}},{"id":2360,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":651,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.confidence","id":2389}},{"id":2363,"name":"recognizedBreak","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized break - the detected start or end of a structural component."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":668,"character":19}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreak","id":2384},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedBreak","id":2392}},{"id":2361,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":658,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedLanguages","id":2390}},{"id":2359,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":646,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.text","id":2388}},{"id":2358,"name":"words","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an Array of `VisionDocumentTextWord`s that make up this paragraph.","text":"Returns an empty list if no Word is found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":571,"character":9}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionDocumentTextWord","id":2364}}}],"groups":[{"title":"Properties","kind":1024,"children":[2362,2360,2363,2361,2359,2358]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":565,"character":46}],"extendedTypes":[{"type":"reference","name":"VisionDocumentTextBase","id":2387}]},{"id":2384,"name":"VisionDocumentTextRecognizedBreak","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A recognized break is the detected start or end of a structural component."},"children":[{"id":2385,"name":"breakType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets detected break type."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":632,"character":13}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreakType","id":2377}},{"id":2386,"name":"isPrefix","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns true if break prepends an element."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":637,"character":12}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[2385,2386]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":628,"character":52}]},{"id":2371,"name":"VisionDocumentTextSymbol","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A single symbol representation."},"children":[{"id":2375,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":663,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.boundingBox","id":2391}},{"id":2373,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":651,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.confidence","id":2389}},{"id":2376,"name":"recognizedBreak","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized break - the detected start or end of a structural component."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":668,"character":19}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreak","id":2384},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedBreak","id":2392}},{"id":2374,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":658,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedLanguages","id":2390}},{"id":2372,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":646,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.text","id":2388}}],"groups":[{"title":"Properties","kind":1024,"children":[2375,2373,2376,2374,2372]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":588,"character":43}],"extendedTypes":[{"type":"reference","name":"VisionDocumentTextBase","id":2387}]},{"id":2364,"name":"VisionDocumentTextWord","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A single word representation."},"children":[{"id":2369,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":663,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.boundingBox","id":2391}},{"id":2367,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":651,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.confidence","id":2389}},{"id":2370,"name":"recognizedBreak","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized break - the detected start or end of a structural component."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":668,"character":19}],"type":{"type":"reference","name":"VisionDocumentTextRecognizedBreak","id":2384},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedBreak","id":2392}},{"id":2368,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":658,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.recognizedLanguages","id":2390}},{"id":2365,"name":"symbols","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an Array of `VisionDocumentTextSymbol`s that make up this word.\nThe order of the symbols follows the natural reading order."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":582,"character":11}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionDocumentTextSymbol","id":2371}}},{"id":2366,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":646,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionDocumentTextBase.text","id":2388}}],"groups":[{"title":"Properties","kind":1024,"children":[2369,2367,2370,2368,2365,2366]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":577,"character":41}],"extendedTypes":[{"type":"reference","name":"VisionDocumentTextBase","id":2387}]},{"id":2426,"name":"VisionFace","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a face returned from `faceDetectorProcessImage()`."},"children":[{"id":2427,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the axis-aligned bounding rectangle of the detected face."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":771,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506}},{"id":2428,"name":"faceContours","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Represent a face contour. A contour is a list of points on a detected face, such as the mouth.","text":"When 'left' and 'right' are used, they are relative to the subject in the image. For example, the `LEFT_EYE`\nlandmark is the subject's left eye, not the eye that is on the left when viewing the image.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":779,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionFaceContour","id":2449}}},{"id":2429,"name":"headEulerAngleY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the rotation of the face about the vertical axis of the image. Positive euler y is when the face turns\ntoward the right side of the of the image that is being processed."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":785,"character":19}],"type":{"type":"intrinsic","name":"number"}},{"id":2430,"name":"headEulerAngleZ","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the rotation of the face about the axis pointing out of the image. Positive euler z is a\ncounter-clockwise rotation within the image plane."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":791,"character":19}],"type":{"type":"intrinsic","name":"number"}},{"id":2431,"name":"landmarks","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an array of `VisionFaceLandmark`.","text":"Returns an empty array if the landmark mode has not been enabled via `setLandmarkMode()`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":798,"character":13}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionFaceLandmark","id":2435}}},{"id":2432,"name":"leftEyeOpenProbability","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a value between 0.0 and 1.0 giving a probability that the face's left eye is open.","text":"Returns -1 if the classification mode has not been enabled via `setClassificationMode()`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":805,"character":26}],"type":{"type":"intrinsic","name":"number"}},{"id":2433,"name":"rightEyeOpenProbability","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a value between 0.0 and 1.0 giving a probability that the face's right eye is open.","text":"Returns -1 if the classification mode has not been enabled via `setClassificationMode()`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":812,"character":27}],"type":{"type":"intrinsic","name":"number"}},{"id":2434,"name":"smilingProbability","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a value between 0.0 and 1.0 giving a probability that the face is smiling.","text":"Returns -1 if the classification mode has not been enabled via `setClassificationMode()`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":819,"character":22}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[2427,2428,2429,2430,2431,2432,2433,2434]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":767,"character":29}]},{"id":2449,"name":"VisionFaceContour","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represent a face contour. A contour is a list of points on a detected face, such as the mouth.\nWhen 'left' and 'right' are used, they are relative to the subject in the image. For example, the `LEFT_EYE` landmark\nis the subject's left eye, not the eye that is on the left when viewing the image."},"children":[{"id":2451,"name":"points","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of 2D points for this face contour, where (0, 0) is the upper-left corner of the image. The point is\nguaranteed to be within the bounds of the image."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":910,"character":10}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}}},{"id":2450,"name":"type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the contour type."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":904,"character":8}],"type":{"type":"reference","name":"VisionFaceContourType","id":2452}}],"groups":[{"title":"Properties","kind":1024,"children":[2451,2450]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":900,"character":36}]},{"id":2303,"name":"VisionFaceDetectorOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Options for vision face detector."},"children":[{"id":2304,"name":"classificationMode","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Indicates whether to run additional classifiers for characterizing attributes such as \"smiling\" and \"eyes open\".","text":"Defaults to `VisionFaceDetectorClassificationMode.NO_CLASSIFICATIONS`.\n\n#### Example\n\n```js\nconst faces = await firebase.vision().faceDetectorProcessImage(filePath, {\n  classificationMode: VisionFaceDetectorClassificationMode.ALL_CLASSIFICATIONS,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":94,"character":22}],"type":{"type":"union","types":[{"type":"reference","name":"NO_CLASSIFICATIONS","id":2336},{"type":"reference","name":"ALL_CLASSIFICATIONS","id":2337}]}},{"id":2305,"name":"contourMode","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets whether to detect no contours or all contours. Processing time increases as the number of contours to search\nfor increases, so detecting all contours will increase the overall detection time. Note that it would return up\nto 5 faces contours.","text":"Defaults to `VisionFaceDetectorContourMode.NO_CONTOURS`.\n\n#### Example\n\n```js\nconst faces = await firebase.vision().faceDetectorProcessImage(filePath, {\n  contourMode: VisionFaceDetectorContourMode.ALL_CONTOURS,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":113,"character":15}],"type":{"type":"union","types":[{"type":"reference","name":"NO_CONTOURS","id":2339},{"type":"reference","name":"ALL_CONTOURS","id":2340}]}},{"id":2306,"name":"landmarkMode","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets whether to detect no landmarks or all landmarks. Processing time increases as the number of landmarks to\nsearch for increases, so detecting all landmarks will increase the overall detection time. Detecting landmarks\ncan improve pose estimation.","text":"Defaults to `VisionFaceDetectorLandmarkMode.NO_LANDMARKS`.\n\n#### Example\n\n```js\nconst faces = await firebase.vision().faceDetectorProcessImage(filePath, {\n  landmarkMode: VisionFaceDetectorLandmarkMode.ALL_LANDMARKS,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":132,"character":16}],"type":{"type":"union","types":[{"type":"reference","name":"NO_LANDMARKS","id":2342},{"type":"reference","name":"ALL_LANDMARKS","id":2343}]}},{"id":2307,"name":"minFaceSize","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets the smallest desired face size, expressed as a proportion of the width of the head to the image width. For\nexample, if a value of 0.1 is specified then the smallest face to search for is roughly 10% of the width of the\nimage being searched.","text":"Setting the min face size is a performance vs. accuracy trade-off: setting the face size smaller will enable the\ndetector to find smaller faces but detection will take longer; setting the face size larger will exclude smaller\nfaces but will run faster.\n\nThis is not a hard limit on face size; the detector may find faces slightly smaller than specified.\n\nDefaults to 0.1.\n\n#### Example\n\n```js\nconst faces = await firebase.vision().faceDetectorProcessImage(filePath, {\n  minFaceSize: 0.5,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":157,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":2308,"name":"performanceMode","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Extended option for controlling additional accuracy / speed trade-offs in performing face detection. In general,\nchoosing the more accurate mode will generally result in longer runtime, whereas choosing the faster mode will\ngenerally result in detecting fewer faces.","text":"Defaults to `VisionFaceDetectorPerformanceMode.FAST`.\n\n#### Example\n\n```js\nconst faces = await firebase.vision().faceDetectorProcessImage(filePath, {\n  performanceMode: VisionFaceDetectorPerformanceMode.ACCURATE,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":174,"character":19}],"type":{"type":"union","types":[{"type":"reference","name":"FAST","id":2345},{"type":"reference","name":"ACCURATE","id":2346}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2304,2305,2306,2307,2308]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":80,"character":44}]},{"id":2435,"name":"VisionFaceLandmark","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represent a face landmark. A landmark is a point on a detected face, such as an eye, nose, or mouth.","text":"When 'left' and 'right' are used, they are relative to the subject in the image.  For example, the `LEFT_EYE` landmark\nis the subject's left eye, not the eye that is on the left when viewing the image.\n"},"children":[{"id":2437,"name":"position","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a 2D point for landmark position, where (0, 0) is the upper-left corner of the image."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":837,"character":12}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}}},{"id":2436,"name":"type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the landmark type."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":832,"character":8}],"type":{"type":"reference","name":"VisionFaceLandmarkType","id":2438}}],"groups":[{"title":"Properties","kind":1024,"children":[2437,2436]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":828,"character":37}]},{"id":2422,"name":"VisionImageLabel","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents an image label return from `imageLabelerProcessImage()` and `cloudImageLabelerProcessImage()`."},"children":[{"id":2425,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets overall confidence of the result.","text":"Range between 0 (low confidence) and 1 (high confidence).\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":761,"character":14}],"type":{"type":"intrinsic","name":"number"}},{"id":2424,"name":"entityId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an opaque entity ID. IDs are available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":754,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":2423,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns a detected label from the given image. The label returned here is in English only.","text":"Use `entityId` to retrieve a unique id.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":749,"character":8}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2425,2424,2423]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":743,"character":35}]},{"id":2309,"name":"VisionImageLabelerOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Options for on device image labeler. Confidence threshold could be provided for the label detection."},"children":[{"id":2310,"name":"confidenceThreshold","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Sets confidence threshold of detected labels. Only labels detected with confidence higher than this threshold are returned.","text":"For example, if the confidence threshold is set to 0.7, only labels with confidence >= 0.7 would be returned.\n\nDefaults to 0.5.\n\n#### Example\n\n```js\nconst labels = await firebase.vision().imageLabelerProcessImage(filePath, {\n  confidenceThreshold: 0.8,\n});\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":200,"character":23}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2310]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":184,"character":44}]},{"id":2467,"name":"VisionLandmark","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a detected landmark returned from `cloudLandmarkRecognizerProcessImage()`."},"children":[{"id":2468,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets image region of the detected landmark. Returns null if nothing was detected"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":995,"character":15}],"type":{"type":"union","types":[{"type":"reference","name":"VisionRectangle","id":2506},{"type":"intrinsic","name":"null"}]}},{"id":2469,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets overall confidence of the result. Ranging between 0 & 1."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1000,"character":14}],"type":{"type":"intrinsic","name":"number"}},{"id":2470,"name":"entityId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1005,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":2471,"name":"landmark","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the detected landmark."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1010,"character":12}],"type":{"type":"intrinsic","name":"string"}},{"id":2472,"name":"locations","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the location information for the detected entity.","text":"Multiple VisionGeoPoint elements can be present because one location may indicate the location of the scene\nin the image, and another location may indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1019,"character":13}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionGeoPoint","id":2508}}}],"groups":[{"title":"Properties","kind":1024,"children":[2468,2469,2470,2471,2472]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":991,"character":33}]},{"id":2347,"name":"VisionText","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A hierarchical representation of texts recognized in an image."},"children":[{"id":2349,"name":"blocks","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an array `VisionTextBlock`, which is a block of text that can be further decomposed to an array of `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":549,"character":10}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionTextBlock","id":2402}}},{"id":2348,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Retrieve the recognized text as a string."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":544,"character":8}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2349,2348]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":540,"character":29}],"extendedBy":[{"type":"reference","name":"VisionDocumentText","id":2393}]},{"id":2396,"name":"VisionTextBase","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A shared type that all Vision Text components inherit from"},"children":[{"id":2400,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":705,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506}},{"id":2398,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":693,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]}},{"id":2401,"name":"cornerPoints","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the four corner points in clockwise direction starting with top-left. Due to the possible perspective distortions, this is not necessarily a rectangle. Parts of the region could be outside of the image."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":710,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}}},{"id":2399,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":700,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}}},{"id":2397,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":688,"character":8}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[2400,2398,2401,2399,2397]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":684,"character":33}],"extendedBy":[{"type":"reference","name":"VisionTextBlock","id":2402},{"type":"reference","name":"VisionTextLine","id":2409},{"type":"reference","name":"VisionTextElement","id":2416}]},{"id":2402,"name":"VisionTextBlock","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a block of text (similar to a paragraph)."},"children":[{"id":2407,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":705,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionTextBase.boundingBox","id":2400}},{"id":2405,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":693,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionTextBase.confidence","id":2398}},{"id":2408,"name":"cornerPoints","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the four corner points in clockwise direction starting with top-left. Due to the possible perspective distortions, this is not necessarily a rectangle. Parts of the region could be outside of the image."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":710,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}},"inheritedFrom":{"type":"reference","name":"VisionTextBase.cornerPoints","id":2401}},{"id":2403,"name":"lines","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an Array of VisionTextLine's that make up this text block."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":720,"character":9}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionTextLine","id":2409}}},{"id":2406,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":700,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionTextBase.recognizedLanguages","id":2399}},{"id":2404,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":688,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionTextBase.text","id":2397}}],"groups":[{"title":"Properties","kind":1024,"children":[2407,2405,2408,2403,2406,2404]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":716,"character":34}],"extendedTypes":[{"type":"reference","name":"VisionTextBase","id":2396}]},{"id":2416,"name":"VisionTextElement","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Roughly equivalent to a space-separated \"word\" in most Latin languages, or a character in others. For instance, if a word is split between two lines by a hyphen, each part is encoded as a separate Element."},"children":[{"id":2420,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":705,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionTextBase.boundingBox","id":2400}},{"id":2418,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":693,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionTextBase.confidence","id":2398}},{"id":2421,"name":"cornerPoints","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the four corner points in clockwise direction starting with top-left. Due to the possible perspective distortions, this is not necessarily a rectangle. Parts of the region could be outside of the image."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":710,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}},"inheritedFrom":{"type":"reference","name":"VisionTextBase.cornerPoints","id":2401}},{"id":2419,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":700,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionTextBase.recognizedLanguages","id":2399}},{"id":2417,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":688,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionTextBase.text","id":2397}}],"groups":[{"title":"Properties","kind":1024,"children":[2420,2418,2421,2419,2417]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":738,"character":36}],"extendedTypes":[{"type":"reference","name":"VisionTextBase","id":2396}]},{"id":2409,"name":"VisionTextLine","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Represents a line of text."},"children":[{"id":2414,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected text."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":705,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506},"inheritedFrom":{"type":"reference","name":"VisionTextBase.boundingBox","id":2400}},{"id":2412,"name":"confidence","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The confidence of the recognized text. It only return valid result from cloud recognizers. For on-device text recognition, the confidence is always null."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":693,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"intrinsic","name":"number"}]},"inheritedFrom":{"type":"reference","name":"VisionTextBase.confidence","id":2398}},{"id":2415,"name":"cornerPoints","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the four corner points in clockwise direction starting with top-left. Due to the possible perspective distortions, this is not necessarily a rectangle. Parts of the region could be outside of the image."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":710,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}},"inheritedFrom":{"type":"reference","name":"VisionTextBase.cornerPoints","id":2401}},{"id":2410,"name":"elements","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an Array of VisionTextElement's that make up this text block.","text":"An element is roughly equivalent to a space-separated \"word\" in most Latin languages, or a character in others. For instance, if a word is split between two lines by a hyphen, each part is encoded as a separate Element.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":732,"character":12}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionTextElement","id":2416}}},{"id":2413,"name":"recognizedLanguages","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets a list of recognized languages. (Cloud API only. On-Device returns empty array)","text":"A language is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":700,"character":23}],"type":{"type":"array","elementType":{"type":"reference","name":"String"}},"inheritedFrom":{"type":"reference","name":"VisionTextBase.recognizedLanguages","id":2399}},{"id":2411,"name":"text","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the recognized text as a string. Returned in reading order for the language. For Latin, this is top to bottom within a `VisionTextBlock`, and left-to-right within a `VisionTextLine`."},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":688,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"VisionTextBase.text","id":2397}}],"groups":[{"title":"Properties","kind":1024,"children":[2414,2412,2415,2410,2413,2411]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":726,"character":33}],"extendedTypes":[{"type":"reference","name":"VisionTextBase","id":2396}]},{"id":2508,"name":"VisionGeoPoint","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"A representation of a latitude/longitude pair.","text":"This is expressed as an array of numbers representing degrees latitude and degrees longitude, in the form `[lat, lng]`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1027,"character":28}],"type":{"type":"tuple","elements":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"number"}]}},{"id":2507,"name":"VisionPoint","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"A point holds two number coordinates relative to the processed image.\nPoints are represented as [x, y].","text":"Used by Vision Text Recognizer, Face Detector & Landmark Recognition APIs.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":535,"character":25}],"type":{"type":"tuple","elements":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"number"}]}},{"id":2506,"name":"VisionRectangle","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"comment":{"shortText":"A Rectangle holds four number coordinates relative to the processed image.\nRectangle are represented as [left, top, right, bottom].","text":"Used by Vision Text Recognizer, Face Detector & Landmark Recognition APIs.\n"},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":527,"character":29}],"type":{"type":"tuple","elements":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Enumerations","kind":4,"children":[2320,2332,2377,2452,2335,2338,2341,2344,2438]},{"title":"Classes","kind":128,"children":[2473]},{"title":"Interfaces","kind":256,"children":[2287,2328,2311,2315,2323,2393,2387,2350,2357,2384,2371,2364,2426,2449,2303,2435,2422,2309,2467,2347,2396,2402,2416,2409]},{"title":"Type aliases","kind":4194304,"children":[2508,2507,2506]}],"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":56,"character":36}]},{"id":2160,"name":"MLKitVision","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Firebase ML Kit package for React Native.","text":"#### Example 1\n\nAccess the firebase export from the `ml-vision` package:\n\n```js\nimport { firebase } from '@react-native-firebase/ml-vision';\n\n// firebase.vision().X\n```\n\n#### Example 2\n\nUsing the default export from the `ml-vision` package:\n\n```js\nimport vision from '@react-native-firebase/ml-vision';\n\n// vision().X\n```\n\n#### Example 3\n\nUsing the default export from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\nimport '@react-native-firebase/ml-vision';\n\n// firebase.vision().X\n```\n","tags":[{"tag":"firebase","text":"ml-vision\n"}]},"children":[{"id":2268,"name":"VisionBarcodeAddressType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The type of a address detected in a barcode.","text":"Use with `VisionBarcodeAddress.type`.\n"},"children":[{"id":2271,"name":"HOME","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Address is specified as a HOME address."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":949,"character":8}],"defaultValue":"2"},{"id":2269,"name":"UNKNOWN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Unknown type"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":939,"character":11}],"defaultValue":"0"},{"id":2270,"name":"WORK","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Address is specified as a WORK address."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":944,"character":8}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2271,2269,2270]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":935,"character":38}]},{"id":2272,"name":"VisionBarcodeEmailType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The type of an email detected in a barcode.","text":"Use with `VisionBarcodeEmail.type`.\n"},"children":[{"id":2275,"name":"HOME","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Email address is specified as a HOME / personal email."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":971,"character":8}],"defaultValue":"2"},{"id":2273,"name":"UNKNOWN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Unknown type"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":961,"character":11}],"defaultValue":"0"},{"id":2274,"name":"WORK","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Email address is specified as a WORK email."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":966,"character":8}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2275,2273,2274]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":957,"character":36}]},{"id":2238,"name":"VisionBarcodeFormat","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Barcode format constants - enumeration of supported barcode formats.","text":"Can be used to specify the known type of a barcode before processing; via `VisionBarcodeDetectorOptions.setBarcodeFormats()`\n"},"children":[{"id":2239,"name":"ALL_FORMATS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant representing the union of all supported formats."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":772,"character":15}],"defaultValue":"0"},{"id":2240,"name":"AZTEC","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for AZTEC."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":777,"character":9}],"defaultValue":"4096"},{"id":2241,"name":"CODABAR","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for Codabar."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":782,"character":11}],"defaultValue":"8"},{"id":2242,"name":"CODE_128","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for Code 128."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":787,"character":12}],"defaultValue":"1"},{"id":2243,"name":"CODE_39","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for Code 39."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":792,"character":11}],"defaultValue":"2"},{"id":2244,"name":"CODE_93","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for Code 93."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":797,"character":11}],"defaultValue":"4"},{"id":2245,"name":"DATA_MATRIX","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for Data Matrix."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":802,"character":15}],"defaultValue":"16"},{"id":2246,"name":"EAN_13","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for EAN-13."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":807,"character":10}],"defaultValue":"32"},{"id":2247,"name":"EAN_8","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for EAN-8."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":812,"character":9}],"defaultValue":"64"},{"id":2248,"name":"ITF","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for ITF (Interleaved Two-of-Five)."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":817,"character":7}],"defaultValue":"128"},{"id":2249,"name":"PDF417","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for PDF-417."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":822,"character":10}],"defaultValue":"2048"},{"id":2250,"name":"QR_CODE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for QR Code."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":827,"character":11}],"defaultValue":"256"},{"id":2251,"name":"UNKNOWN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format unknown to the current SDK, but understood by Google Play services."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":832,"character":11}],"defaultValue":" -1"},{"id":2252,"name":"UPC_A","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for UPC-A."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":837,"character":9}],"defaultValue":"512"},{"id":2253,"name":"UPC_E","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Barcode format constant for UPC-E."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":842,"character":9}],"defaultValue":"1024"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2239,2240,2241,2242,2243,2244,2245,2246,2247,2248,2249,2250,2251,2252,2253]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":768,"character":33}]},{"id":2276,"name":"VisionBarcodePhoneType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The type of a phone number detected in a barcode.","text":"Use with `VisionBarcodePhone.type`.\n"},"children":[{"id":2277,"name":"FAX","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Fax machine."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":983,"character":7}],"defaultValue":"3"},{"id":2278,"name":"HOME","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Home phone."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":988,"character":8}],"defaultValue":"2"},{"id":2279,"name":"MOBILE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Mobile Phone."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":993,"character":10}],"defaultValue":"4"},{"id":2280,"name":"UNKNOWN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Unknown type."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":998,"character":11}],"defaultValue":"0"},{"id":2281,"name":"WORK","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Work phone."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":1003,"character":8}],"defaultValue":"1"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2277,2278,2279,2280,2281]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":979,"character":36}]},{"id":2254,"name":"VisionBarcodeValueType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"Barcode value type constants - enumeration of supported barcode content value types.","text":"Can be used with `VisionBarcode.valueType` to determine the barcode content type of a detected barcode.\n\n#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\n// check for a calendar event barcode value type\nif (barcode && barcode.valueType === VisionBarcodeValueType.CALENDAR_EVENT) {\n  console.log(barcode.calendarEvent);\n}\n```\n"},"children":[{"id":2255,"name":"CALENDAR_EVENT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for calendar events."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":867,"character":18}],"defaultValue":"11"},{"id":2256,"name":"CONTACT_INFO","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for contact information."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":872,"character":16}],"defaultValue":"1"},{"id":2257,"name":"DRIVER_LICENSE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for driver's license data."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":877,"character":18}],"defaultValue":"12"},{"id":2258,"name":"EMAIL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for email message details."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":882,"character":9}],"defaultValue":"2"},{"id":2259,"name":"GEO","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for geographic coordinates."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":887,"character":7}],"defaultValue":"10"},{"id":2260,"name":"ISBN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for ISBNs."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":892,"character":8}],"defaultValue":"3"},{"id":2261,"name":"PHONE","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for phone numbers."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":897,"character":9}],"defaultValue":"4"},{"id":2262,"name":"PRODUCT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for product codes."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":902,"character":11}],"defaultValue":"5"},{"id":2263,"name":"SMS","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for SMS details."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":907,"character":7}],"defaultValue":"6"},{"id":2264,"name":"TEXT","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for plain text."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":912,"character":8}],"defaultValue":"7"},{"id":2265,"name":"UNKNOWN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type unknown, which indicates the current version of SDK cannot recognize the structure of the barcode."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":917,"character":11}],"defaultValue":"0"},{"id":2266,"name":"URL","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for URLs/bookmarks."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":922,"character":7}],"defaultValue":"8"},{"id":2267,"name":"WIFI","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":" Barcode value type constant for WiFi access point details."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":927,"character":8}],"defaultValue":"9"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2255,2256,2257,2258,2259,2260,2261,2262,2263,2264,2265,2266,2267]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":863,"character":36}]},{"id":2282,"name":"VisionBarcodeWifiEncryptionType","kind":4,"kindString":"Enumeration","flags":{"isExported":true},"comment":{"shortText":"The type of wifi encryption used for a `VisionBarcodeWifi` instance.","text":"Use with `VisionBarcodeWifi.encryptionType`.\n"},"children":[{"id":2283,"name":"OPEN","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Wifi has no encryption and is open."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":1015,"character":8}],"defaultValue":"1"},{"id":2285,"name":"WEP","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Wifi uses WEP encryption."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":1025,"character":7}],"defaultValue":"3"},{"id":2284,"name":"WPA","kind":16,"kindString":"Enumeration member","flags":{"isExported":true},"comment":{"shortText":"Wifi uses WPA encryption. This includes WPA2."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":1020,"character":7}],"defaultValue":"2"}],"groups":[{"title":"Enumeration members","kind":16,"children":[2283,2285,2284]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":1011,"character":45}]},{"id":2161,"name":"VisionBarcode","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A representation of a barcode detected in an image.","text":"#### Example\n\n```js\nconst [barcode, ...otherBarcodes] = await firebase.vision().barcodeDetectorProcessImage(filePath);\nconsole.log(barcode);\n```\n"},"children":[{"id":2162,"name":"boundingBox","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the bounding rectangle of the detected barcode."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":52,"character":15}],"type":{"type":"reference","name":"VisionRectangle","id":2506}},{"id":2168,"name":"calendarEvent","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed calendar event (set if `valueType` is `VisionBarcodeValueType.CALENDAR_EVENT`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CALENDAR_EVENT) {\n  console.log(barcode.calendarEvent);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":113,"character":17}],"type":{"type":"reference","name":"VisionBarcodeCalendarEvent","id":2202}},{"id":2169,"name":"contactInfo","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed contact details (set if `valueType` is `VisionBarcodeValueType.CONTACT_INFO`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":130,"character":15}],"type":{"type":"reference","name":"VisionBarcodeContactInfo","id":2210}},{"id":2163,"name":"cornerPoints","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the four corner points in clockwise direction starting with top-left. Due to the possible perspective distortions, this is not necessarily a rectangle. Parts of the region could be outside of the image."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":57,"character":16}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionPoint","id":2507}}},{"id":2166,"name":"displayValue","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns barcode value in a user-friendly format.","text":"May omit some of the information encoded in the barcode. For example, if `'rawValue returns `MEBKM:TITLE:Invertase;URL://invertase.io;;'`, the display_value might be `'//invertase.io'`.\n\nIf `valueType` === `VisionBarcodeValueType.TEXT`, this field will be identical to `rawValue`.\n\nThis value can also be multiline, for example, when line breaks are encoded into the original `TEXT` barcode value.\n\nReturns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":87,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2170,"name":"driverLicense","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed drivers license details (set if `valueType` is `VisionBarcodeValueType.DRIVER_LICENSE`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.DRIVER_LICENSE) {\n  console.log(barcode.driverLicense);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":147,"character":17}],"type":{"type":"reference","name":"VisionBarcodeDriverLicense","id":2187}},{"id":2171,"name":"email","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed email details (set if `valueType` is `VisionBarcodeValueType.EMAIL`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.EMAIL) {\n  console.log(barcode.email);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":164,"character":9}],"type":{"type":"reference","name":"VisionBarcodeEmail","id":2229}},{"id":2164,"name":"format","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns the barcode format, for example `VisionBarcodeFormat.QR_CODE`","text":"Use with `VisionBarcodeFormat` to switch based on format if needed.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":64,"character":10}],"type":{"type":"intrinsic","name":"number"}},{"id":2172,"name":"geoPoint","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed Geo Point details (set if `valueType` is `VisionBarcodeValueType.GEO`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.GEO) {\n  console.log(barcode.geoPoint);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":181,"character":12}],"type":{"type":"reference","name":"VisionGeoPoint","id":2508}},{"id":2173,"name":"phone","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed phone details (set if `valueType` is `VisionBarcodeValueType.PHONE`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.PHONE) {\n  console.log(barcode.phone);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":198,"character":9}],"type":{"type":"reference","name":"VisionBarcodePhone","id":2233}},{"id":2167,"name":"rawValue","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns barcode value as it was encoded in the barcode.","text":"Structured values are not parsed.\n\nReturns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":96,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2174,"name":"sms","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed sms details (set if `valueType` is `VisionBarcodeValueType.SMS`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.SMS) {\n  console.log(barcode.sms);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":215,"character":7}],"type":{"type":"reference","name":"VisionBarcodeSms","id":2184}},{"id":2175,"name":"url","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed url details (set if `valueType` is `VisionBarcodeValueType.URL`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.URL) {\n  console.log(barcode.url);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":232,"character":7}],"type":{"type":"reference","name":"VisionBarcodeUrl","id":2181}},{"id":2165,"name":"valueType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns type of the barcode value, for example `VisionBarcodeValueType.EMAIL`.","text":"If the value structure cannot be parsed, `VisionBarcodeValueType.TEXT` will be returned.\nIf the recognized structure type is not defined in the current version of the native Firebase SDKs, `VisionBarcodeValueType.UNKNOWN` will be returned.\n\nNote that the built-in parsers only recognize a few popular value structures. For your specific use case, you might want to directly consume `rawValue` and implement your own parsing logic.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":74,"character":13}],"type":{"type":"intrinsic","name":"number"}},{"id":2176,"name":"wifi","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Gets parsed wifi details (set if `valueType` is `VisionBarcodeValueType.WIFI`).","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.WIFI) {\n  console.log(barcode.wifi);\n}\n```\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":249,"character":8}],"type":{"type":"reference","name":"VisionBarcodeWifi","id":2177}}],"groups":[{"title":"Properties","kind":1024,"children":[2162,2168,2169,2163,2166,2170,2171,2164,2172,2173,2167,2174,2175,2165,2176]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":48,"character":32}]},{"id":2218,"name":"VisionBarcodeAddress","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A contacts address."},"children":[{"id":2219,"name":"lines","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"An array of address line strings of the formatted address."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":602,"character":9}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2220,"name":"type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The address type, e.g. `VisionBarcodeAddressType.WORK`."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":607,"character":8}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[2219,2220]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":598,"character":39}]},{"id":2202,"name":"VisionBarcodeCalendarEvent","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A calendar event extracted from QRCode.","text":"```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CALENDAR_EVENT) {\n  console.log(barcode.calendarEvent);\n}\n```\n"},"children":[{"id":2203,"name":"description","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The description of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":486,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2204,"name":"end","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The end date time of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":493,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2205,"name":"location","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The location of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":500,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2206,"name":"organizer","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The organizer of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":507,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2207,"name":"start","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The start date time of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":514,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2208,"name":"status","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The status of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":521,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2209,"name":"summary","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The summary of the calendar event.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":528,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2203,2204,2205,2206,2207,2208,2209]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":480,"character":45}]},{"id":2210,"name":"VisionBarcodeContactInfo","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A persons or organization's business card. For example a VCARD.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo);\n}\n```\n"},"children":[{"id":2217,"name":"addresses","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets an array of the contact persons addresses.","text":"Returns an empty array if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":592,"character":13}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionBarcodeAddress","id":2218}}},{"id":2215,"name":"emails","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the contact persons emails.","text":"Returns an empty array if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":580,"character":10}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionBarcodeEmail","id":2229}}},{"id":2216,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the contact persons name."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":585,"character":8}],"type":{"type":"reference","name":"VisionBarcodePersonName","id":2221}},{"id":2213,"name":"organization","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the contact persons organization.","text":"Returns `null` if no organization detected.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":566,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2214,"name":"phones","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the contact persons phones.","text":"Returns an empty array if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":573,"character":10}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionBarcodePhone","id":2233}}},{"id":2212,"name":"title","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the contact persons title. E.g. `Dr`","text":"Returns `null` if no title detected.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":559,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2211,"name":"urls","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Get an array of detected urls for the contact.","text":"Returns an empty array if nothing found;\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":552,"character":8}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"groups":[{"title":"Properties","kind":1024,"children":[2217,2215,2216,2213,2214,2212,2211]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":546,"character":43}]},{"id":2236,"name":"VisionBarcodeDetectorOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Custom options for barcode detection.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeFormat, VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath, {\n  barcodeFormats: [VisionBarcodeFormat.QR_CODE]\n});\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo);\n}\n```\n"},"children":[{"id":2237,"name":"barcodeFormats","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Set the barcode formats to detect.","text":"Defaults to `VisionBarcodeFormat.ALL_FORMATS`;\n","tags":[{"tag":"param","text":"Array of `VisionBarcodeFormat` types.\n","param":"formats"}]},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":760,"character":18}],"type":{"type":"array","elementType":{"type":"reference","name":"VisionBarcodeFormat","id":2238}}}],"groups":[{"title":"Properties","kind":1024,"children":[2237]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":752,"character":47}]},{"id":2187,"name":"VisionBarcodeDriverLicense","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A driver license or ID card.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.DRIVER_LICENSE) {\n  console.log(barcode.driverLicense);\n}\n```\n"},"children":[{"id":2188,"name":"addressCity","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets city of holder's address.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":373,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2189,"name":"addressState","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets state of holder's address.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":380,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2190,"name":"addressStreet","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The holder's street address.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":387,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2191,"name":"addressZip","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The zip code of holder's address.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":394,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2192,"name":"birthDate","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The birth date of the holder.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":401,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2193,"name":"documentType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The \"DL\" for driver licenses, \"ID\" for ID cards.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":408,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2194,"name":"expiryDate","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The expiry date of the license.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":415,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2195,"name":"firstName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The holder's first name.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":422,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2196,"name":"gender","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The holder's gender.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":429,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2197,"name":"issueDate","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The issue date of the license.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":436,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2198,"name":"issuingCountry","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The country in which DL/ID was issued.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":443,"character":18}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2199,"name":"lastName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The holder's last name.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":450,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2200,"name":"licenseNumber","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The driver license ID number.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":457,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2201,"name":"middleName","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The holder's middle name.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":464,"character":14}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2188,2189,2190,2191,2192,2193,2194,2195,2196,2197,2198,2199,2200,2201]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":367,"character":45}]},{"id":2229,"name":"VisionBarcodeEmail","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An email message from a 'MAILTO:' or similar QRCode type, or from a ContactInfo/VCARD.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.EMAIL) {\n  console.log(barcode.email);\n} else if (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo.emails[0]);\n}\n```\n"},"children":[{"id":2230,"name":"address","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The email address.","text":"Returns `null` if non detected for this `type`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":685,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2231,"name":"body","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The email body content.","text":"Returns `null` if no body detected.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":692,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2232,"name":"subject","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The email subject.","text":"Returns `null` if no subject was detected.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":699,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2230,2231,2232]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":679,"character":37}]},{"id":2221,"name":"VisionBarcodePersonName","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A persons name, both formatted version and their individual name components."},"children":[{"id":2222,"name":"first","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The persons first name.","text":"Returns `null` if not found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":619,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2223,"name":"formatted","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A properly formatted name.","text":"Returns `null` if no name components found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":626,"character":13}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2224,"name":"last","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The persons last name.","text":"Returns `null` if not found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":633,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2225,"name":"middle","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The persons middle name.","text":"Returns `null` if not found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":640,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2226,"name":"prefix","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The prefix of the name.","text":"Returns `null` if not found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":647,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2227,"name":"pronunciation","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Designates a text string to be set as the kana name in the phonebook."},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":652,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2228,"name":"suffix","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The suffix of the persons name.","text":"Returns `null` if not found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":659,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2222,2223,2224,2225,2226,2227,2228]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":613,"character":42}]},{"id":2233,"name":"VisionBarcodePhone","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A phone number and it's detected type, e.g. `VisionBarcodePhoneType.MOBILE`","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.PHONE) {\n  console.log(barcode.phone);\n} else if (barcode && barcode.valueType === VisionBarcodeValueType.CONTACT_INFO) {\n  console.log(barcode.contactInfo.phones[0]);\n}\n```\n"},"children":[{"id":2234,"name":"number","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The detected phone number.","text":"Returns `null` if no number detected for this type.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":725,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2235,"name":"type","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets type of the phone number, e.g. `VisionBarcodePhoneType.MOBILE`.","text":"See also `VisionBarcodePhoneType`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":732,"character":8}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[2234,2235]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":719,"character":37}]},{"id":2184,"name":"VisionBarcodeSms","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"An sms message from an 'SMS:' or similar QRCode type.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.SMS) {\n  console.log(barcode.sms);\n}\n```\n"},"children":[{"id":2185,"name":"message","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The message text for this SMS.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":342,"character":11}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2186,"name":"phoneNumber","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The phone number for this SMS.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":349,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2185,2186]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":336,"character":35}]},{"id":2181,"name":"VisionBarcodeUrl","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A URL and title from a 'MEBKM:' or similar QRCode type.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.URL) {\n  console.log(barcode.url);\n}\n```\n"},"children":[{"id":2182,"name":"title","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The title for this url.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":311,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2183,"name":"url","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The URL.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":318,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2182,2183]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":305,"character":35}]},{"id":2177,"name":"VisionBarcodeWifi","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Wifi network parameters from a 'WIFI:' or similar QRCode type.","text":"#### Example\n\n```js\nimport vision, { VisionBarcodeValueType } from '@react-native-firebase/ml-vision';\n\nconst [barcode, ...otherBarcodes] = await vision().barcodeDetectorProcessImage(filePath);\n\nif (barcode && barcode.valueType === VisionBarcodeValueType.WIFI) {\n  console.log(barcode.wifi);\n}\n```\n"},"children":[{"id":2178,"name":"encryptionType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The encryption type of the WIFI. e.g. `VisionBarcodeWifiEncryptionType.WPA`","text":"See all types at `VisionBarcodeWifiEncryptionType`.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":273,"character":18}],"type":{"type":"intrinsic","name":"number"}},{"id":2179,"name":"password","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The password for this WIFI.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":280,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":2180,"name":"ssid","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The SSID for this WIFI.","text":"Returns `null` if nothing found.\n"},"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":287,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[2178,2179,2180]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":267,"character":36}]}],"groups":[{"title":"Enumerations","kind":4,"children":[2268,2272,2238,2276,2254,2282]},{"title":"Interfaces","kind":256,"children":[2161,2218,2202,2210,2236,2187,2229,2221,2233,2184,2181,2177]}],"sources":[{"fileName":"packages/ml-vision/lib/BarcodeDetectorTypes.d.ts","line":37,"character":28}]},{"id":1,"name":"ReactNativeFirebase","kind":2,"kindString":"Module","flags":{"isExported":true},"comment":{"shortText":"Core React Native Firebase package.","text":"#### Example 1\n\nAccess the default firebase app from the `app` package:\n\n```js\nimport firebase from '@react-native-firebase/app';\n\nconsole.log(firebase.app().name);\n```\n","tags":[{"tag":"firebase","text":"app\n"}]},"children":[{"id":46,"name":"FirebaseModule","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A class that all React Native Firebase modules extend from to provide default behaviour."},"children":[{"id":47,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"}},{"id":49,"name":"emitter","kind":1024,"kindString":"Property","flags":{"isPrivate":true,"isExported":true},"comment":{"shortText":"Returns the shared event emitter instance used for all JS event routing."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":211,"character":19}],"type":{"type":"intrinsic","name":"any"}},{"id":48,"name":"native","kind":1024,"kindString":"Property","flags":{"isPrivate":true,"isExported":true},"comment":{"shortText":"The native module instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":206,"character":18}],"type":{"type":"intrinsic","name":"any"}}],"groups":[{"title":"Properties","kind":1024,"children":[47,49,48]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":197,"character":29}],"extendedBy":[{"type":"reference","name":"Module","id":77},{"type":"reference","name":"Module","id":243},{"type":"reference","name":"Module","id":428},{"type":"reference","name":"Module","id":746},{"type":"reference","name":"Module","id":843},{"type":"reference","name":"Module","id":1185},{"type":"reference","name":"Module","id":1265},{"type":"reference","name":"Module","id":1818},{"type":"reference","name":"Module","id":1890},{"type":"reference","name":"Module","id":1909},{"type":"reference","name":"Module","id":1932},{"type":"reference","name":"Module","id":2020},{"type":"reference","name":"Module","id":2133},{"type":"reference","name":"Module","id":2473},{"type":"reference","name":"Module","id":2601},{"type":"reference","name":"Module","id":2651},{"type":"reference","name":"Module","id":2840}]},{"id":28,"name":"FirebaseApp","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":29,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The name (identifier) for this App. '[DEFAULT]' is the default App."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":140,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":30,"name":"options","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The (read-only) configuration options from the app initialization."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":145,"character":20}],"type":{"type":"reference","name":"FirebaseAppOptions","id":11}},{"id":31,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":32,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Make this app unusable and free up resources."},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"void"}]}}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":150,"character":10}]}],"groups":[{"title":"Properties","kind":1024,"children":[29,30]},{"title":"Methods","kind":2048,"children":[31]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":136,"character":30}]},{"id":24,"name":"FirebaseAppConfig","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":26,"name":"automaticDataCollectionEnabled","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":127,"character":34}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":27,"name":"automaticResourceManagement","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"If set to true it indicates that Firebase should close database connections\nautomatically when the app is in the background. Disabled by default."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":133,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":25,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Firebase App name, defaults to [DEFAULT] if none provided."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":122,"character":8}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[26,27,25]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":118,"character":36}]},{"id":11,"name":"FirebaseAppOptions","kind":256,"kindString":"Interface","flags":{"isExported":true},"indexSignature":[{"id":22,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":23,"name":"name","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"any"}}],"children":[{"id":20,"name":"androidClientId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"iOS only - The Android client ID used in Google AppInvite when an iOS app has its Android version, for\nexample \"12345.apps.googleusercontent.com\"."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":109,"character":19}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":13,"name":"apiKey","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An API key used for authenticating requests from your app, e.g.\n\"AIzaSyDdVgKwhZl0sTTTLZ7iTmt1r3N2cJLnaDk\", used to identify your app to Google servers."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":71,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":12,"name":"appId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Google App ID that is used to uniquely identify an instance of an app."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":65,"character":9}],"type":{"type":"intrinsic","name":"string"}},{"id":19,"name":"clientId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"iOS only - The OAuth2 client ID for iOS application used to authenticate Google users, for example\n\"12345.apps.googleusercontent.com\", used for signing in with Google."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":103,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":14,"name":"databaseURL","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The database root URL, e.g. \"http://abc-xyz-123.firebaseio.com\"."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":76,"character":15}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":21,"name":"deepLinkURLScheme","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"iOS only - The URL scheme used to set up Durable Deep Link service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":114,"character":21}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":16,"name":"gaTrackingId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The tracking ID for Google Analytics, e.g. \"UA-12345678-1\", used to configure Google Analytics."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":86,"character":16}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":18,"name":"messagingSenderId","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Project Number from the Google Developer's console, for example \"012345678901\", used to\nconfigure Google Cloud Messaging."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":97,"character":21}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":15,"name":"projectId","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Project ID from the Firebase console, for example \"abc-xyz-123\"."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":81,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":17,"name":"storageBucket","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The Google Cloud Storage bucket name, e.g. \"abc-xyz-123.storage.firebase.com\"."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":91,"character":17}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[20,13,12,19,14,21,16,18,15,17]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":61,"character":37}]},{"id":50,"name":"FirebaseJsonConfig","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"React Native Firebase `firebase.json` config"},"children":[{"id":272,"name":"admob_android_app_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Google AdMob application App ID for Android.","text":"This can be found under: Apps > App settings > App ID on the Google AdMob dashboard.\n\nFor testing purposes, use the App ID: `ca-app-pub-3940256099942544~3347511713`.\n","tags":[{"tag":"android","text":"\n"}]},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1221,"character":24}],"type":{"type":"intrinsic","name":"string"}},{"id":274,"name":"admob_delay_app_measurement_init","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"By default, the Google Mobile Ads SDK initializes app measurement and begins sending user-level event data to\nGoogle immediately when the app starts. This initialization behavior ensures you can enable AdMob user metrics\nwithout making additional code changes.","text":"If you require your app users to provide consent before collecting data, setting the value to `true` will prevent\ndata being sent until the `firebase.admob().initialize()` method has been called.\n"},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1242,"character":36}],"type":{"type":"intrinsic","name":"boolean"}},{"id":273,"name":"admob_ios_app_id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The Google AdMob application App ID for iOS.","text":"This can be found under: Apps > App settings > App ID on the Google AdMob dashboard.\n\nFor testing purposes, use the App ID: `ca-app-pub-3940256099942544~1458002511`.\n","tags":[{"tag":"ios","text":"\n"}]},"sources":[{"fileName":"packages/admob/lib/index.d.ts","line":1232,"character":20}],"type":{"type":"intrinsic","name":"string"}},{"id":555,"name":"analytics_auto_collection_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Disable or enable auto collection of analytics data.","text":"This is useful for opt-in-first data flows, for example when dealing with GDPR compliance.\nThis can be overridden in JavaScript.\n\n#### Example\n\n```json\n// <project-root>/firebase.json\n{\n  \"react-native\": {\n    \"analytics_auto_collection_enabled\": false\n  }\n}\n```\n\n```js\n// Re-enable analytics data collection, e.g. once user has granted permission:\nawait firebase.analytics().setAnalyticsCollectionEnabled(true);\n```\n"},"sources":[{"fileName":"packages/analytics/lib/index.d.ts","line":1407,"character":37}],"type":{"type":"intrinsic","name":"boolean"}},{"id":885,"name":"crashlytics_auto_collection_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":263,"character":39}],"type":{"type":"intrinsic","name":"boolean"}},{"id":884,"name":"crashlytics_debug_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":262,"character":29}],"type":{"type":"intrinsic","name":"boolean"}},{"id":883,"name":"crashlytics_ndk_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/crashlytics/lib/index.d.ts","line":261,"character":27}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1217,"name":"database_persistence_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Set whether database persistence is enabled or disabled.","text":"This can be overridden in JavaScript, e.g. when requesting permission or on a condition.\n\n#### Example\n\n```json\n// <project-root>/firebase.json\n{\n  \"react-native\": {\n    \"database_persistence_enabled\": false\n  }\n}\n```\n\n```js\n// Re-enable database persistence\nawait firebase.database().setPersistenceEnabled(true);\n```\n"},"sources":[{"fileName":"packages/database/lib/index.d.ts","line":1288,"character":32}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1949,"name":"in_app_messaging_auto_collection_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Disable or enable auto collection & receiving of in-app messages and data collection.","text":"This is useful for opt-in-first data flows, for example when dealing with GDPR compliance.\nThis can be overridden in JavaScript.\n\n#### Example\n\n```json\n// <project-root>/firebase.json\n{\n  \"react-native\": {\n    \"in_app_messaging_auto_collection_enabled\": false\n  }\n}\n```\n\n```js\n// Re-enable in-app messaging, e.g. once user has granted permission:\nawait firebase.inAppMessaging().setAutomaticDataCollectionEnabled(true);\n```\n"},"sources":[{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":194,"character":44}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2121,"name":"messaging_android_headless_task_timeout","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":966,"character":43}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"number"}]}},{"id":2122,"name":"messaging_android_notification_channel_id","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":967,"character":45}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2123,"name":"messaging_android_notification_color","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":968,"character":40}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}},{"id":2120,"name":"messaging_auto_init_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"packages/messaging/lib/index.d.ts","line":965,"character":31}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"false"},{"type":"intrinsic","name":"true"}]}},{"id":2158,"name":"ml_natural_language_language_id_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If `true`, the Language ID Model will be installed onto the device."},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":267,"character":41}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2159,"name":"ml_natural_language_smart_reply_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"If `true`, the Smart Reply Model will be installed onto the device."},"sources":[{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":272,"character":41}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2533,"name":"ml_vision_barcode_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1233,"character":27}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2531,"name":"ml_vision_face_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1231,"character":24}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2535,"name":"ml_vision_image_label_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1235,"character":31}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2534,"name":"ml_vision_label_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1234,"character":25}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2532,"name":"ml_vision_ocr_model","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/ml-vision/lib/index.d.ts","line":1232,"character":23}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2625,"name":"perf_auto_collection_enabled","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Disable or enable auto collection of performance monitoring data collection.","text":"This is useful for opt-in-first data flows, for example when dealing with GDPR compliance.\nThis can be overridden in JavaScript.\n\n#### Example\n\n```json\n// <project-root>/firebase.json\n{\n  \"react-native\": {\n    \"perf_auto_collection_enabled\": false\n  }\n}\n```\n\n```js\n// Re-enable performance monitoring data collection, e.g. once user has granted permission:\nawait firebase.perf().setPerformanceCollectionEnabled(true);\n```\n"},"sources":[{"fileName":"packages/perf/lib/index.d.ts","line":503,"character":32}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[272,274,273,555,885,884,883,1217,1949,2121,2122,2123,2120,2158,2159,2533,2531,2535,2534,2532,2625]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":235,"character":37},{"fileName":"packages/admob/lib/index.d.ts","line":1211,"character":30},{"fileName":"packages/analytics/lib/index.d.ts","line":1384,"character":30},{"fileName":"packages/crashlytics/lib/index.d.ts","line":260,"character":30},{"fileName":"packages/database/lib/index.d.ts","line":1266,"character":30},{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":171,"character":30},{"fileName":"packages/messaging/lib/index.d.ts","line":964,"character":30},{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":263,"character":30},{"fileName":"packages/ml-vision/lib/index.d.ts","line":1230,"character":30},{"fileName":"packages/perf/lib/index.d.ts","line":480,"character":30}]},{"id":33,"name":"Module","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":45,"name":"SDK_VERSION","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current React Native Firebase version."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":191,"character":24}],"type":{"type":"intrinsic","name":"string"}},{"id":44,"name":"apps","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A (read-only) array of all the initialized Apps."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":186,"character":8}],"type":{"type":"array","elementType":{"type":"reference","name":"FirebaseApp"}}},{"id":41,"name":"app","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":42,"name":"app","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Retrieve an instance of a FirebaseApp.","tags":[{"tag":"example","text":"\n```js\nconst app = firebase.app('foo');\n```\n"}]},"parameters":[{"id":43,"name":"name","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The optional name of the app to return ('[DEFAULT]' if omitted)\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"FirebaseApp"}}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":181,"character":7}]},{"id":34,"name":"initializeApp","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":35,"name":"initializeApp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Create (and initialize) a FirebaseApp."},"parameters":[{"id":36,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options to configure the services used in the App."},"type":{"type":"reference","name":"FirebaseAppOptions","id":11}},{"id":37,"name":"config","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The optional config for your firebase app\n"},"type":{"type":"reference","name":"FirebaseAppConfig","id":24}}],"type":{"type":"reference","name":"FirebaseApp"}},{"id":38,"name":"initializeApp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Create (and initialize) a FirebaseApp."},"parameters":[{"id":39,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Options to configure the services used in the App."},"type":{"type":"reference","name":"FirebaseAppOptions","id":11}},{"id":40,"name":"name","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The optional name of the app to initialize ('[DEFAULT]' if\nomitted)\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]}}],"type":{"type":"reference","name":"FirebaseApp"}}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":160,"character":17},{"fileName":"packages/app/lib/index.d.ts","line":169,"character":17}]}],"groups":[{"title":"Properties","kind":1024,"children":[45,44]},{"title":"Methods","kind":2048,"children":[41,34]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":153,"character":25}]},{"id":2,"name":"NativeFirebaseError","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":10,"name":"Error","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":984,"character":17}],"type":{"type":"reference","name":"ErrorConstructor"}},{"id":3,"name":"code","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Firebase error code, e.g. `auth/invalid-email`"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":38,"character":17}],"type":{"type":"intrinsic","name":"string"}},{"id":4,"name":"message","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Firebase error message"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":43,"character":20}],"type":{"type":"intrinsic","name":"string"},"overwrites":{"type":"reference","name":"Error.message"}},{"id":8,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":973,"character":8}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","name":"Error.name"}},{"id":5,"name":"namespace","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The firebase module namespace that this error originated from, e.g. 'analytics'"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":48,"character":22}],"type":{"type":"intrinsic","name":"string"}},{"id":6,"name":"nativeErrorCode","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The native sdks returned error code, different per platform"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":53,"character":28}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"}]}},{"id":7,"name":"nativeErrorMessage","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The native sdks returned error message, different per platform"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":58,"character":31}],"type":{"type":"intrinsic","name":"string"}},{"id":9,"name":"stack","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts","line":975,"character":9}],"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"string"}]},"inheritedFrom":{"type":"reference","name":"Error.stack"}}],"groups":[{"title":"Properties","kind":1024,"children":[10,3,4,8,5,6,7,9]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":34,"character":38}],"extendedTypes":[{"type":"reference","name":"Error"}]},{"id":51,"name":"FirebaseModuleWithStatics","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"typeParameter":[{"id":52,"name":"M","kind":131072,"kindString":"Type parameter","flags":{}},{"id":53,"name":"S","kind":131072,"kindString":"Type parameter","flags":{}}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":214,"character":39}],"type":{"type":"intersection","types":[{"type":"reflection","declaration":{"id":54,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":55,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"typeParameter","name":"M"}}],"children":[{"id":56,"name":"SDK_VERSION","kind":32,"kindString":"Variable","flags":{},"comment":{"shortText":"This React Native Firebase module version."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":220,"character":24}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Variables","kind":32,"children":[56]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":214,"character":52}]}},{"type":"typeParameter","name":"S"}]}},{"id":57,"name":"FirebaseModuleWithStaticsAndApp","kind":4194304,"kindString":"Type alias","flags":{"isExported":true},"typeParameter":[{"id":58,"name":"M","kind":131072,"kindString":"Type parameter","flags":{}},{"id":59,"name":"S","kind":131072,"kindString":"Type parameter","flags":{}}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":223,"character":45}],"type":{"type":"intersection","types":[{"type":"reflection","declaration":{"id":60,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":61,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":62,"name":"app","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"FirebaseApp","id":28}}],"type":{"type":"typeParameter","name":"M"}}],"children":[{"id":63,"name":"SDK_VERSION","kind":32,"kindString":"Variable","flags":{},"comment":{"shortText":"This React Native Firebase module version."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":229,"character":24}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Variables","kind":32,"children":[63]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":223,"character":58}]}},{"type":"typeParameter","name":"S"}]}}],"groups":[{"title":"Classes","kind":128,"children":[46]},{"title":"Interfaces","kind":256,"children":[28,24,11,50,33,2]},{"title":"Type aliases","kind":4194304,"children":[51,57]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":33,"character":36},{"fileName":"packages/admob/lib/index.d.ts","line":1210,"character":29},{"fileName":"packages/analytics/lib/index.d.ts","line":1383,"character":29},{"fileName":"packages/crashlytics/lib/index.d.ts","line":259,"character":29},{"fileName":"packages/database/lib/index.d.ts","line":1265,"character":29},{"fileName":"packages/in-app-messaging/lib/index.d.ts","line":170,"character":29},{"fileName":"packages/messaging/lib/index.d.ts","line":963,"character":29},{"fileName":"packages/ml-natural-language/lib/index.d.ts","line":262,"character":29},{"fileName":"packages/ml-vision/lib/index.d.ts","line":1229,"character":29},{"fileName":"packages/perf/lib/index.d.ts","line":479,"character":29}]},{"id":64,"name":"Utils","kind":2,"kindString":"Module","flags":{"isExported":true},"children":[{"id":77,"name":"Module","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The React Native Firebase Utils service interface.","text":"> This module is available for the default app only.\n\n#### Example\n\nGet the Utils service for the default app:\n\n```js\nconst defaultAppUtils = firebase.utils();\n```\n"},"children":[{"id":79,"name":"app","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current `FirebaseApp` instance for this Firebase service."},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":201,"character":7}],"type":{"type":"reference","name":"FirebaseApp"},"inheritedFrom":{"type":"reference","name":"FirebaseModule.app","id":47}},{"id":78,"name":"isRunningInTestLab","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns true if this app is running inside a Firebase Test Lab environment. Always returns false on iOS.","tags":[{"tag":"android","text":"\n"}]},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":381,"character":22}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[79,78]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":375,"character":21}],"extendedTypes":[{"type":"reference","name":"FirebaseModule","id":46}]},{"id":65,"name":"FilePath","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"A collection of native device file paths to aid in the usage of file path based methods.","text":"Concatenate a file path with your target file name when using with Storage `putFile` or `writeToFile`.\n\n```js\nfirebase.utils.FilePath;\n```\n"},"children":[{"id":67,"name":"CACHES_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to the application specific cache directory on the filesystem.","text":"The system will automatically delete files in this directory when disk space is needed elsewhere on the device, starting with the oldest files first.\n\n```js\nfirebase.utils.FilePath.CACHES_DIRECTORY;\n```\n"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":274,"character":20}],"type":{"type":"intrinsic","name":"string"}},{"id":68,"name":"DOCUMENT_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to the users Documents directory.","text":"Use this directory to place documents that have been created by the user.\n\n```js\nfirebase.utils.FilePath.DOCUMENT_DIRECTORY;\n```\n"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":285,"character":22}],"type":{"type":"intrinsic","name":"string"}},{"id":71,"name":"EXTERNAL_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to the directory on the primary shared/external storage device.","text":"Here your application can place persistent files it owns. These files are internal to the application, and not typically visible to the user as media.\n\nReturns null if no external storage directory found, e.g. removable media has been ejected by the user.\n\n```js\nfirebase.utils.FilePath.EXTERNAL_DIRECTORY;\n```\n","tags":[{"tag":"android","text":"Android only - iOS returns null\n"}]},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":322,"character":22}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":72,"name":"EXTERNAL_STORAGE_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to the primary shared/external storage directory.","text":"Traditionally this is an SD card, but it may also be implemented as built-in storage on a device.\n\nReturns null if no external storage directory found, e.g. removable media has been ejected by the user.\n\n```js\nfirebase.utils.FilePath.EXTERNAL_STORAGE_DIRECTORY;\n```\n","tags":[{"tag":"android","text":"Android only - iOS returns null\n"}]},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":337,"character":30}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"null"}]}},{"id":70,"name":"LIBRARY_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to the apps library/resources directory.","text":"E.g. this can be used for things like documentation, support files, and configuration files and generic resources.\n\n```js\nfirebase.utils.FilePath.LIBRARY_DIRECTORY;\n```\n"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":307,"character":21}],"type":{"type":"intrinsic","name":"string"}},{"id":66,"name":"MAIN_BUNDLE","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to the applications main bundle.","text":"```js\nfirebase.utils.FilePath.MAIN_BUNDLE;\n```\n","tags":[{"tag":"ios","text":"iOS only\n"}]},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":263,"character":15}],"type":{"type":"intrinsic","name":"string"}},{"id":74,"name":"MOVIES_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to a directory in which to place movies that are available to the user.","text":"```js\nfirebase.utils.FilePath.MOVIES_DIRECTORY;\n```\n"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":355,"character":20}],"type":{"type":"intrinsic","name":"string"}},{"id":73,"name":"PICTURES_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to a directory in which to place pictures that are available to the user.","text":"```js\nfirebase.utils.FilePath.PICTURES_DIRECTORY;\n```\n"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":346,"character":22}],"type":{"type":"intrinsic","name":"string"}},{"id":69,"name":"TEMP_DIRECTORY","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Returns an absolute path to a temporary directory.","text":"Use this directory to create temporary files. The system will automatically delete files in this directory when disk space is needed elsewhere on the device, starting with the oldest files first.\n\n```js\nfirebase.utils.FilePath.TEMP_DIRECTORY;\n```\n"},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":296,"character":18}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[67,68,71,72,70,66,74,73,69]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":253,"character":27}]},{"id":75,"name":"Statics","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":76,"name":"FilePath","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"packages/app/lib/index.d.ts","line":359,"character":12}],"type":{"type":"reference","name":"FilePath","id":65}}],"groups":[{"title":"Properties","kind":1024,"children":[76]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":358,"character":26}]}],"groups":[{"title":"Classes","kind":128,"children":[77]},{"title":"Interfaces","kind":256,"children":[65,75]}],"sources":[{"fileName":"packages/app/lib/index.d.ts","line":241,"character":22}]},{"id":2868,"name":"interstitial","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/admob/type-test.ts","line":61,"character":18}],"type":{"type":"reference","name":"InterstitialAd","id":204},"defaultValue":" admob.InterstitialAd.createForAdRequest('foo', {\n  keywords: ['test'],\n})"},{"id":2873,"name":"metric","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/perf/type-test.ts","line":46,"character":12}],"type":{"type":"reference","name":"HttpMetric","id":2568},"defaultValue":" firebase.perf().newHttpMetric('foo', 'GET')"},{"id":2871,"name":"r","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/database/type-test.ts","line":55,"character":7}],"type":{"type":"reference","name":"Reference","id":894},"defaultValue":" firebase.database().ref('foo')"},{"id":2874,"name":"ref","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/storage/type-test.ts","line":41,"character":9}],"type":{"type":"reference","name":"Reference","id":2731},"defaultValue":" firebase.storage().ref('foo')"},{"id":2869,"name":"rewardedAd","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/admob/type-test.ts","line":95,"character":16}],"type":{"type":"reference","name":"RewardedAd","id":219},"defaultValue":" admob.RewardedAd.createForAdRequest('foo', {\n  keywords: ['test'],\n})"},{"id":2875,"name":"task","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/storage/type-test.ts","line":54,"character":10}],"type":{"type":"reference","name":"Task","id":2785},"defaultValue":" firebase\n  .storage()\n  .ref('foo')\n  .putString('foo')"},{"id":2872,"name":"trace","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/perf/type-test.ts","line":36,"character":11}],"type":{"type":"reference","name":"Trace","id":2537},"defaultValue":" firebase.perf().newTrace('foo')"},{"id":2870,"name":"u","kind":32,"kindString":"Variable","flags":{"isConst":true},"sources":[{"fileName":"packages/auth/type-test.ts","line":49,"character":7}],"type":{"type":"union","types":[{"type":"intrinsic","name":"null"},{"type":"reference","name":"User","id":699}]},"defaultValue":" firebase.auth().currentUser"}],"groups":[{"title":"Modules","kind":2,"children":[254,548,80,834,876,1209,1286,1850,1899,1923,1942,2113,2151,2509,2618,2677,2860,89,275,556,841,886,1218,1293,1857,1907,1930,2124,1950,2536,2626,2684,2286,2160,1,64]},{"title":"Variables","kind":32,"children":[2868,2873,2871,2874,2869,2875,2872,2870]}]}
\ No newline at end of file
diff --git a/docs/typescript.md b/docs/typescript.md
index ec850513..cc676c43 100644
--- a/docs/typescript.md
+++ b/docs/typescript.md
@@ -2,7 +2,7 @@
 title: TypeScript
 description: Using TypeScript with React Native Firebase
 next: /migrating-to-v6
-previous: 
+previous:
 ---
 
 The React Native Firebase project comes with support for TypeScript. The project provides
@@ -53,7 +53,7 @@ TypeScript will no longer show any errors, allowing us to safely continue develo
 
 It is also possible to access the module types directly, if you need to locally reference variables within your own codebase.
 
-For example, we may need to store the `User` in local state. Manually defining a type for local state TypeScript loses the ability to type check the code. 
+For example, we may need to store the `User` in local state. Manually defining a type for local state TypeScript loses the ability to type check the code.
 
 We can easily access the types manually through the module though, for example:
 
@@ -63,8 +63,8 @@ import { useEffect, useState } from 'react';
 import auth, { FirebaseAuthTypes } from '@react-native-firebase/auth';
 
 function App() {
-  const [loading, setLoading] = useState<boolean>(true);
-  const [user, setUser] = useState<FirebaseAuthTypes.User | null>(null);
+  const [loading, setLoading] = useState < boolean > true;
+  const [user, setUser] = (useState < FirebaseAuthTypes.User) | (null > null);
 
   useEffect(() => {
     auth().onAuthStateChanged(userState => {