Skip to content

Commit 6399504

Browse files
committed
Add remarks where needed
1 parent bb9863a commit 6399504

File tree

26 files changed

+91
-56
lines changed

26 files changed

+91
-56
lines changed

docs-devsite/analytics.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# analytics package
13-
Firebase Analytics
13+
The Firebase Analytics Web SDK.
14+
15+
The Firebase Analytics Web SDK currently does not work in Node.js.
1416

1517
## Functions
1618

docs-devsite/app-check.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# app-check package
13-
Firebase App Check
13+
The Firebase App Check Web SDK.
14+
15+
Firebase App Check does not work in Node.js using `ReCaptchaV3Provider` or `ReCaptchaEnterpriseProvider`<!-- -->, but can be used in Node.js if you use `CustomProvider` and write your own attestation method.
1416

1517
## Functions
1618

docs-devsite/auth.auth.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,8 @@ This will affect the currently saved Auth session and applies this type of persi
221221

222222
This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data.
223223

224+
This method has no effect in Node.js.
225+
224226
<b>Signature:</b>
225227

226228
```typescript

docs-devsite/auth.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Firebase Authentication
5757
| [getIdToken(user, forceRefresh)](./auth.md#getidtoken) | Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. |
5858
| [getIdTokenResult(user, forceRefresh)](./auth.md#getidtokenresult) | Returns a deserialized JSON Web Token (JWT) used to identify the user to a Firebase service. |
5959
| [linkWithCredential(user, credential)](./auth.md#linkwithcredential) | Links the user account with the given credentials. |
60-
| [linkWithPhoneNumber(user, phoneNumber, appVerifier)](./auth.md#linkwithphonenumber) | Links the user account with the given phone number. |
60+
| [linkWithPhoneNumber(user, phoneNumber, appVerifier)](./auth.md#linkwithphonenumber) | Links the user account with the given phone number.<!-- -->This method is not available in Node.js. |
6161
| [linkWithPopup(user, provider, resolver)](./auth.md#linkwithpopup) | Links the authenticated provider to the user account using a pop-up based OAuth flow. |
6262
| [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. |
6363
| [multiFactor(user)](./auth.md#multifactor) | The [MultiFactorUser](./auth.multifactoruser.md#multifactoruser_interface) corresponding to the user. |
@@ -92,7 +92,7 @@ Firebase Authentication
9292
| [PhoneAuthCredential](./auth.phoneauthcredential.md#phoneauthcredential_class) | Represents the credentials returned by [PhoneAuthProvider](./auth.phoneauthprovider.md#phoneauthprovider_class)<!-- -->. |
9393
| [PhoneAuthProvider](./auth.phoneauthprovider.md#phoneauthprovider_class) | Provider for generating an [PhoneAuthCredential](./auth.phoneauthcredential.md#phoneauthcredential_class)<!-- -->. |
9494
| [PhoneMultiFactorGenerator](./auth.phonemultifactorgenerator.md#phonemultifactorgenerator_class) | Provider for generating a [PhoneMultiFactorAssertion](./auth.phonemultifactorassertion.md#phonemultifactorassertion_interface)<!-- -->. |
95-
| [RecaptchaVerifier](./auth.recaptchaverifier.md#recaptchaverifier_class) | An [reCAPTCHA](https://www.google.com/recaptcha/)<!-- -->-based application verifier. |
95+
| [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. |
9696
| [SAMLAuthProvider](./auth.samlauthprovider.md#samlauthprovider_class) | An [AuthProvider](./auth.authprovider.md#authprovider_interface) for SAML. |
9797
| [TotpMultiFactorGenerator](./auth.totpmultifactorgenerator.md#totpmultifactorgenerator_class) | Provider for generating a [TotpMultiFactorAssertion](./auth.totpmultifactorassertion.md#totpmultifactorassertion_interface)<!-- -->. |
9898
| [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
147147
| [ActionCodeOperation](./auth.md#actioncodeoperation) | An enumeration of the possible email action types. |
148148
| [AuthErrorCodes](./auth.md#autherrorcodes) | A map of potential <code>Auth</code> error codes, for easier comparison with errors thrown by the SDK. |
149149
| [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. |
150-
| [browserPopupRedirectResolver](./auth.md#browserpopupredirectresolver) | An implementation of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) suitable for browser based applications. |
150+
| [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. |
151151
| [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. |
152152
| [cordovaPopupRedirectResolver](./auth.md#cordovapopupredirectresolver) | An implementation of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) suitable for Cordova based applications. |
153153
| [debugErrorMap](./auth.md#debugerrormap) | A verbose error map with detailed descriptions for most error codes.<!-- -->See discussion at [AuthErrorMap](./auth.autherrormap.md#autherrormap_interface) |
@@ -453,7 +453,7 @@ export declare function getRedirectResult(auth: Auth, resolver?: PopupRedirectRe
453453
| Parameter | Type | Description |
454454
| --- | --- | --- |
455455
| auth | [Auth](./auth.auth.md#auth_interface) | The [Auth](./auth.auth.md#auth_interface) instance. |
456-
| 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)<!-- -->. |
456+
| 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. |
457457

458458
<b>Returns:</b>
459459

@@ -720,6 +720,7 @@ A `Promise` that resolves once the persistence change has completed
720720
setPersistence(auth, browserSessionPersistence);
721721

722722
```
723+
This method has no effect in Node.js.
723724

724725
## signInAnonymously()
725726

@@ -906,6 +907,7 @@ const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applic
906907
const credential = await confirmationResult.confirm(verificationCode);
907908

908909
```
910+
This method is not available in Node.js.
909911

910912
## signInWithPopup()
911913

@@ -925,7 +927,7 @@ export declare function signInWithPopup(auth: Auth, provider: AuthProvider, reso
925927
| --- | --- | --- |
926928
| auth | [Auth](./auth.auth.md#auth_interface) | The [Auth](./auth.auth.md#auth_interface) instance. |
927929
| 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. |
928-
| 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)<!-- -->. |
930+
| 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. |
929931

930932
<b>Returns:</b>
931933

@@ -965,7 +967,7 @@ export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, r
965967
| --- | --- | --- |
966968
| auth | [Auth](./auth.auth.md#auth_interface) | The [Auth](./auth.auth.md#auth_interface) instance. |
967969
| 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. |
968-
| 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)<!-- -->. |
970+
| 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. |
969971

970972
<b>Returns:</b>
971973

@@ -1204,6 +1206,8 @@ Promise&lt;[UserCredential](./auth.usercredential.md#usercredential_interface)<!
12041206

12051207
Links the user account with the given phone number.
12061208

1209+
This method is not available in Node.js.
1210+
12071211
<b>Signature:</b>
12081212

12091213
```typescript
@@ -1257,6 +1261,7 @@ const provider = new FacebookAuthProvider();
12571261
await linkWithPopup(result.user, provider);
12581262

12591263
```
1264+
This method is not available in Node.js.
12601265

12611266
## linkWithRedirect()
12621267

@@ -1276,7 +1281,7 @@ export declare function linkWithRedirect(user: User, provider: AuthProvider, res
12761281
| --- | --- | --- |
12771282
| user | [User](./auth.user.md#user_interface) | The user. |
12781283
| 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. |
1279-
| 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)<!-- -->. |
1284+
| 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. |
12801285

12811286
<b>Returns:</b>
12821287

@@ -1349,6 +1354,8 @@ Re-authenticates a user using a fresh phone credential.
13491354

13501355
Use before operations such as [updatePassword()](./auth.md#updatepassword) that require tokens from recent sign-in attempts.
13511356

1357+
This method is not available in Node.js.
1358+
13521359
<b>Signature:</b>
13531360

13541361
```typescript
@@ -1402,6 +1409,7 @@ const result = await signInWithPopup(auth, provider);
14021409
await reauthenticateWithPopup(result.user, provider);
14031410

14041411
```
1412+
This method is not available in Node.js.
14051413

14061414
## reauthenticateWithRedirect()
14071415

@@ -1421,7 +1429,7 @@ export declare function reauthenticateWithRedirect(user: User, provider: AuthPro
14211429
| --- | --- | --- |
14221430
| user | [User](./auth.user.md#user_interface) | The user. |
14231431
| 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. |
1424-
| 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)<!-- -->. |
1432+
| 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. |
14251433

14261434
<b>Returns:</b>
14271435

@@ -1615,6 +1623,7 @@ const phoneCredential = PhoneAuthProvider.credential(verificationId, verificatio
16151623
await updatePhoneNumber(user, phoneCredential);
16161624
16171625
```
1626+
This method is not available in Node.js.
16181627

16191628
## updateProfile()
16201629

@@ -1855,6 +1864,8 @@ browserLocalPersistence: Persistence
18551864

18561865
An implementation of [PopupRedirectResolver](./auth.popupredirectresolver.md#popupredirectresolver_interface) suitable for browser based applications.
18571866

1867+
This method is not available in Node.js.
1868+
18581869
<b>Signature:</b>
18591870

18601871
```typescript

docs-devsite/auth.phoneauthprovider.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,4 +253,5 @@ const phoneCredential = PhoneAuthProvider.credential(verificationId, verificatio
253253
const userCredential = await signInWithCredential(auth, phoneCredential);
254254

255255
```
256+
`PhoneAuthProvider` is not available in Node.js.
256257

docs-devsite/auth.phonemultifactorgenerator.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export declare class PhoneMultiFactorGenerator
2828

2929
| Method | Modifiers | Description |
3030
| --- | --- | --- |
31-
| [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. |
31+
| [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. |
3232

3333
## PhoneMultiFactorGenerator.FACTOR\_ID
3434

@@ -44,6 +44,8 @@ static FACTOR_ID: string;
4444

4545
Provides a [PhoneMultiFactorAssertion](./auth.phonemultifactorassertion.md#phonemultifactorassertion_interface) to confirm ownership of the phone second factor.
4646

47+
This method is not available in Node.js.
48+
4749
<b>Signature:</b>
4850

4951
```typescript

docs-devsite/auth.recaptchaverifier.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ https://github.com/firebase/firebase-js-sdk
1212
# RecaptchaVerifier class
1313
An [reCAPTCHA](https://www.google.com/recaptcha/)<!-- -->-based application verifier.
1414

15+
`RecaptchaVerifier` is not available in Node.js.
16+
1517
<b>Signature:</b>
1618

1719
```typescript

0 commit comments

Comments
 (0)