Run v9 docgen

Author: hsubox76

docs-devsite/analytics.md

@@ -10,9 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # analytics package
-The Firebase Analytics Web SDK.
-
-The Firebase Analytics Web SDK currently does not work in Node.js.
+The Firebase Analytics Web SDK. This SDK currently does not work in Node.js.
 
 ## Functions
 

docs-devsite/auth.md

@@ -57,7 +57,7 @@ Firebase Authentication
 |  [getIdToken(user, forceRefresh)](./auth.md#getidtoken) | Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. |
 |  [getIdTokenResult(user, forceRefresh)](./auth.md#getidtokenresult) | Returns a deserialized JSON Web Token (JWT) used to identify the user to a Firebase service. |
 |  [linkWithCredential(user, credential)](./auth.md#linkwithcredential) | Links the user account with the given credentials. |
-|  [linkWithPhoneNumber(user, phoneNumber, appVerifier)](./auth.md#linkwithphonenumber) | Links the user account with the given phone number.<!-- -->This method is not available in Node.js. |
+|  [linkWithPhoneNumber(user, phoneNumber, appVerifier)](./auth.md#linkwithphonenumber) | Links the user account with the given phone number. |
 |  [linkWithPopup(user, provider, resolver)](./auth.md#linkwithpopup) | Links the authenticated provider to the user account using a pop-up based OAuth flow. |
 |  [linkWithRedirect(user, provider, resolver)](./auth.md#linkwithredirect) | Links the [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class) to the user account using a full-page redirect flow. |
 |  [multiFactor(user)](./auth.md#multifactor) | The [MultiFactorUser](./auth.multifactoruser.md#multifactoruser_interface) corresponding to the user. |
@@ -92,7 +92,7 @@ Firebase Authentication
 |  [PhoneAuthCredential](./auth.phoneauthcredential.md#phoneauthcredential_class) | Represents the credentials returned by [PhoneAuthProvider](./auth.phoneauthprovider.md#phoneauthprovider_class)<!-- -->. |
 |  [PhoneAuthProvider](./auth.phoneauthprovider.md#phoneauthprovider_class) | Provider for generating an [PhoneAuthCredential](./auth.phoneauthcredential.md#phoneauthcredential_class)<!-- -->. |
 |  [PhoneMultiFactorGenerator](./auth.phonemultifactorgenerator.md#phonemultifactorgenerator_class) | Provider for generating a [PhoneMultiFactorAssertion](./auth.phonemultifactorassertion.md#phonemultifactorassertion_interface)<!-- -->. |
-|  [RecaptchaVerifier](./auth.recaptchaverifier.md#recaptchaverifier_class) | An [reCAPTCHA](https://www.google.com/recaptcha/)<!-- -->-based application verifier.<code>RecaptchaVerifier</code> is not available in Node.js. |
+|  [RecaptchaVerifier](./auth.recaptchaverifier.md#recaptchaverifier_class) | An [reCAPTCHA](https://www.google.com/recaptcha/)<!-- -->-based application verifier. |
 |  [SAMLAuthProvider](./auth.samlauthprovider.md#samlauthprovider_class) | An [AuthProvider](./auth.authprovider.md#authprovider_interface) for SAML. |
 |  [TotpMultiFactorGenerator](./auth.totpmultifactorgenerator.md#totpmultifactorgenerator_class) | Provider for generating a [TotpMultiFactorAssertion](./auth.totpmultifactorassertion.md#totpmultifactorassertion_interface)<!-- -->. |
 |  [TotpSecret](./auth.totpsecret.md#totpsecret_class) | Provider for generating a [TotpMultiFactorAssertion](./auth.totpmultifactorassertion.md#totpmultifactorassertion_interface)<!-- -->.<!-- -->Stores the shared secret key and other parameters to generate time-based OTPs. Implements methods to retrieve the shared secret key and generate a QR code URL. |
@@ -147,7 +147,7 @@ Firebase Authentication
 |  [ActionCodeOperation](./auth.md#actioncodeoperation) | An enumeration of the possible email action types. |
 |  [AuthErrorCodes](./auth.md#autherrorcodes) | A map of potential <code>Auth</code> error codes, for easier comparison with errors thrown by the SDK. |
 |  [browserLocalPersistence](./auth.md#browserlocalpersistence) | An implementation of [Persistence](./auth.persistence.md#persistence_interface) of type <code>LOCAL</code> using <code>localStorage</code> for the underlying storage. |
-|  [browserPopupRedirectResolver](./auth.md#browserpopupredirectresolver) | An implementation of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) suitable for browser based applications.<!-- -->This method is not available in Node.js. |
+|  [browserPopupRedirectResolver](./auth.md#browserpopupredirectresolver) | An implementation of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) suitable for browser based applications. |
 |  [browserSessionPersistence](./auth.md#browsersessionpersistence) | An implementation of [Persistence](./auth.persistence.md#persistence_interface) of <code>SESSION</code> using <code>sessionStorage</code> for the underlying storage. |
 |  [cordovaPopupRedirectResolver](./auth.md#cordovapopupredirectresolver) | An implementation of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) suitable for Cordova based applications. |
 |  [debugErrorMap](./auth.md#debugerrormap) | A verbose error map with detailed descriptions for most error codes.<!-- -->See discussion at [AuthErrorMap](./auth.autherrormap.md#autherrormap_interface) |
@@ -442,6 +442,8 @@ Returns a [UserCredential](./auth.usercredential.md#usercredential_interface) fr
 
 If sign-in succeeded, returns the signed in user. If sign-in was unsuccessful, fails with an error. If no redirect operation was called, returns `null`<!-- -->.
 
+This method is not available in Node.js.
+
 <b>Signature:</b>
 
 ```typescript
@@ -453,7 +455,7 @@ export declare function getRedirectResult(auth: Auth, resolver?: PopupRedirectRe
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  auth | [Auth](./auth.auth.md#auth_interface) | The [Auth](./auth.auth.md#auth_interface) instance. |
-|  resolver | [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) | An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!-- -->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!-- -->.<!-- -->This method is not available in Node.js. |
+|  resolver | [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) | An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!-- -->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!-- -->. |
 
 <b>Returns:</b>
 
@@ -878,6 +880,8 @@ This method sends a code via SMS to the given phone number, and returns a [Confi
 
 For abuse prevention, this method also requires a [ApplicationVerifier](./auth.applicationverifier.md#applicationverifier_interface)<!-- -->. This SDK includes a reCAPTCHA-based implementation, [RecaptchaVerifier](./auth.recaptchaverifier.md#recaptchaverifier_class)<!-- -->. This function can work on other platforms that do not support the [RecaptchaVerifier](./auth.recaptchaverifier.md#recaptchaverifier_class) (like React Native), but you need to use a third-party [ApplicationVerifier](./auth.applicationverifier.md#applicationverifier_interface) implementation.
 
+This method is not available in Node.js.
+
 <b>Signature:</b>
 
 ```typescript
@@ -907,14 +911,15 @@ const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applic
 const credential = await confirmationResult.confirm(verificationCode);
 
 ```
-This method is not available in Node.js.
 
 ## signInWithPopup()
 
 Authenticates a Firebase client using a popup-based OAuth authentication flow.
 
 If succeeds, returns the signed in user along with the provider's credential. If sign in was unsuccessful, returns an error object containing additional information about the error.
 
+This method is not available in Node.js.
+
 <b>Signature:</b>
 
 ```typescript
@@ -927,7 +932,7 @@ export declare function signInWithPopup(auth: Auth, provider: AuthProvider, reso
 |  --- | --- | --- |
 |  auth | [Auth](./auth.auth.md#auth_interface) | The [Auth](./auth.auth.md#auth_interface) instance. |
 |  provider | [AuthProvider](./auth.authprovider.md#authprovider_interface) | The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class)<!-- -->. Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md#emailauthprovider_class) will throw an error. |
-|  resolver | [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) | An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!-- -->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!-- -->.<!-- -->This method is not available in Node.js. |
+|  resolver | [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) | An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!-- -->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!-- -->. |
 
 <b>Returns:</b>
 
@@ -955,6 +960,8 @@ Authenticates a Firebase client using a full-page redirect flow.
 
 To handle the results and errors for this operation, refer to [getRedirectResult()](./auth.md#getredirectresult)<!-- -->. Follow the [best practices](https://firebase.google.com/docs/auth/web/redirect-best-practices) when using [signInWithRedirect()](./auth.md#signinwithredirect)<!-- -->.
 
+This method is not available in Node.js.
+
 <b>Signature:</b>
 
 ```typescript
@@ -967,7 +974,7 @@ export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, r
 |  --- | --- | --- |
 |  auth | [Auth](./auth.auth.md#auth_interface) | The [Auth](./auth.auth.md#auth_interface) instance. |
 |  provider | [AuthProvider](./auth.authprovider.md#authprovider_interface) | The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class)<!-- -->. Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md#emailauthprovider_class) will throw an error. |
-|  resolver | [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) | An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!-- -->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!-- -->.<!-- -->This method is not available in Node.js. |
+|  resolver | [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) | An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!-- -->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!-- -->. |
 
 <b>Returns:</b>
 
@@ -1232,6 +1239,8 @@ Links the authenticated provider to the user account using a pop-up based OAuth
 
 If the linking is successful, the returned result will contain the user and the provider's credential.
 
+This method is not available in Node.js.
+
 <b>Signature:</b>
 
 ```typescript
@@ -1261,14 +1270,15 @@ const provider = new FacebookAuthProvider();
 await linkWithPopup(result.user, provider);
 
 ```
-This method is not available in Node.js.
 
 ## linkWithRedirect()
 
 Links the [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class) to the user account using a full-page redirect flow.
 
 To handle the results and errors for this operation, refer to [getRedirectResult()](./auth.md#getredirectresult)<!-- -->. Follow the [best practices](https://firebase.google.com/docs/auth/web/redirect-best-practices) when using [linkWithRedirect()](./auth.md#linkwithredirect)<!-- -->.
 
+This method is not available in Node.js.
+
 <b>Signature:</b>
 
 ```typescript
@@ -1281,7 +1291,7 @@ export declare function linkWithRedirect(user: User, provider: AuthProvider, res
 |  --- | --- | --- |
 |  user | [User](./auth.user.md#user_interface) | The user. |
 |  provider | [AuthProvider](./auth.authprovider.md#authprovider_interface) | The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class)<!-- -->. Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md#emailauthprovider_class) will throw an error. |
-|  resolver | [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) | An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!-- -->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!-- -->.<!-- -->This method is not available in Node.js. |
+|  resolver | [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) | An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!-- -->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!-- -->. |
 
 <b>Returns:</b>
 
@@ -1380,6 +1390,8 @@ Reauthenticates the current user with the specified [OAuthProvider](./auth.oauth
 
 If the reauthentication is successful, the returned result will contain the user and the provider's credential.
 
+This method is not available in Node.js.
+
 <b>Signature:</b>
 
 ```typescript
@@ -1409,14 +1421,15 @@ const result = await signInWithPopup(auth, provider);
 await reauthenticateWithPopup(result.user, provider);
 
 ```
-This method is not available in Node.js.
 
 ## reauthenticateWithRedirect()
 
 Reauthenticates the current user with the specified [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class) using a full-page redirect flow.
 
 To handle the results and errors for this operation, refer to [getRedirectResult()](./auth.md#getredirectresult)<!-- -->. Follow the [best practices](https://firebase.google.com/docs/auth/web/redirect-best-practices) when using [reauthenticateWithRedirect()](./auth.md#reauthenticatewithredirect)<!-- -->.
 
+This method is not available in Node.js.
+
 <b>Signature:</b>
 
 ```typescript
@@ -1429,7 +1442,7 @@ export declare function reauthenticateWithRedirect(user: User, provider: AuthPro
 |  --- | --- | --- |
 |  user | [User](./auth.user.md#user_interface) | The user. |
 |  provider | [AuthProvider](./auth.authprovider.md#authprovider_interface) | The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class)<!-- -->. Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md#emailauthprovider_class) will throw an error. |
-|  resolver | [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) | An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!-- -->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!-- -->.<!-- -->This method is not available in Node.js. |
+|  resolver | [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) | An instance of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface)<!-- -->, optional if already supplied to [initializeAuth()](./auth.md#initializeauth) or provided by [getAuth()](./auth.md#getauth)<!-- -->. |
 
 <b>Returns:</b>
 
@@ -1593,6 +1606,8 @@ Promise&lt;void&gt;
 
 Updates the user's phone number.
 
+This method is not available in Node.js.
+
 <b>Signature:</b>
 
 ```typescript
@@ -1623,7 +1638,6 @@ const phoneCredential = PhoneAuthProvider.credential(verificationId, verificatio
 await updatePhoneNumber(user, phoneCredential);
 
 ```
-This method is not available in Node.js.
 
 ## updateProfile()
 

docs-devsite/auth.phoneauthprovider.md

@@ -12,6 +12,8 @@ https://github.com/firebase/firebase-js-sdk
 # PhoneAuthProvider class
 Provider for generating an [PhoneAuthCredential](./auth.phoneauthcredential.md#phoneauthcredential_class)<!-- -->.
 
+`PhoneAuthProvider` is not available in Node.js.
+
 <b>Signature:</b>
 
 ```typescript
@@ -253,5 +255,4 @@ const phoneCredential = PhoneAuthProvider.credential(verificationId, verificatio
 const userCredential = await signInWithCredential(auth, phoneCredential);
 
 ```
-`PhoneAuthProvider` is not available in Node.js.
 

docs-devsite/auth.phonemultifactorgenerator.md

@@ -28,7 +28,7 @@ export declare class PhoneMultiFactorGenerator
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [assertion(credential)](./auth.phonemultifactorgenerator.md#phonemultifactorgeneratorassertion) | <code>static</code> | Provides a [PhoneMultiFactorAssertion](./auth.phonemultifactorassertion.md#phonemultifactorassertion_interface) to confirm ownership of the phone second factor.<!-- -->This method is not available in Node.js. |
+|  [assertion(credential)](./auth.phonemultifactorgenerator.md#phonemultifactorgeneratorassertion) | <code>static</code> | Provides a [PhoneMultiFactorAssertion](./auth.phonemultifactorassertion.md#phonemultifactorassertion_interface) to confirm ownership of the phone second factor. |
 
 ## PhoneMultiFactorGenerator.FACTOR\_ID
 

docs-devsite/index.md

@@ -15,16 +15,16 @@ https://github.com/firebase/firebase-js-sdk
 
 |  Package | Description |
 |  --- | --- |
-|  [@firebase/analytics](./analytics.md#analytics_package) | The Firebase Analytics Web SDK.<!-- -->The Firebase Analytics Web SDK currently does not work in Node.js. |
+|  [@firebase/analytics](./analytics.md#analytics_package) | The Firebase Analytics Web SDK. This SDK currently does not work in Node.js. |
 |  [@firebase/app](./app.md#app_package) | Firebase App |
-|  [@firebase/app-check](./app-check.md#app-check_package) | The Firebase App Check Web SDK.<!-- -->Firebase App Check does not work in Node.js using <code>ReCaptchaV3Provider</code> or <code>ReCaptchaEnterpriseProvider</code>, but can be used in Node.js if you use <code>CustomProvider</code> and write your own attestation method. |
+|  [@firebase/app-check](./app-check.md#app-check_package) | The Firebase App Check Web SDK. |
 |  [@firebase/auth](./auth.md#auth_package) | Firebase Authentication |
 |  [@firebase/database](./database.md#database_package) | Firebase Realtime Database |
 |  [@firebase/firestore](./firestore.md#firestore_package) | Cloud Firestore |
 |  [@firebase/functions](./functions.md#functions_package) | Cloud Functions for Firebase |
-|  [@firebase/installations](./installations.md#installations_package) | The Firebase Installations Web SDK.<!-- -->The Firebase Installations Web SDK currently does not work in Node.js. |
-|  [@firebase/messaging](./messaging.md#messaging_package) | The Firebase Cloud Messaging Web SDK.<!-- -->The Firebase Cloud Messaging Web SDK currently does not work in Node.js. |
-|  [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK.<!-- -->The Firebase Performance Monitoring Web SDK currently does not work in Node.js. |
-|  [@firebase/remote-config](./remote-config.md#remote-config_package) | The Firebase Remote Config Web SDK.<!-- -->The Firebase Remote Config Web SDK currently does not work in Node.js. |
+|  [@firebase/installations](./installations.md#installations_package) | The Firebase Installations Web SDK. This SDK currently does not work in Node.js. |
+|  [@firebase/messaging](./messaging.md#messaging_package) | The Firebase Cloud Messaging Web SDK. This SDK currently does not work in Node.js. |
+|  [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK. This SDK currently does not work in Node.js. |
+|  [@firebase/remote-config](./remote-config.md#remote-config_package) | The Firebase Remote Config Web SDK. This SDK currently does not work in Node.js. |
 |  [@firebase/storage](./storage.md#storage_package) | Cloud Storage for Firebase |
 

docs-devsite/installations.md

@@ -10,9 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # installations package
-The Firebase Installations Web SDK.
-
-The Firebase Installations Web SDK currently does not work in Node.js.
+The Firebase Installations Web SDK. This SDK currently does not work in Node.js.
 
 ## Functions