Skip to content

Commit 5dfd5b9

Browse files
hsubox76hsubox76
committed
Make wording consistent.
1 parent c4d63b1 commit 5dfd5b9

File tree

28 files changed

+75
-75
lines changed

28 files changed

+75
-75
lines changed

‎docs-devsite/analytics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# analytics package
13-
The Firebase Analytics Web SDK. This SDK does not work in Node.js.
13+
The Firebase Analytics Web SDK. This SDK does not work in a Node.js environment.
1414

1515
## Functions
1616

‎docs-devsite/app-check.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ https://github.com/firebase/firebase-js-sdk
1212
# app-check package
1313
The Firebase App Check Web SDK.
1414

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.
15+
Firebase App Check does not work in a Node.js environment using `ReCaptchaV3Provider` or `ReCaptchaEnterpriseProvider`<!-- -->, but can be used in Node.js if you use `CustomProvider` and write your own attestation method.
1616

1717
## Functions
1818

‎docs-devsite/auth.auth.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ 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.
224+
This method does not work in a Node.js environment.
225225

226226
<b>Signature:</b>
227227

‎docs-devsite/auth.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@ Returns a [UserCredential](./auth.usercredential.md#usercredential_interface) fr
442442

443443
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`<!-- -->.
444444

445-
This method is not available in Node.js.
445+
This method does not work in a Node.js environment.
446446

447447
<b>Signature:</b>
448448

@@ -696,7 +696,7 @@ Changes the type of persistence on the [Auth](./auth.auth.md#auth_interface) ins
696696

697697
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.
698698

699-
This method has no effect in Node.js.
699+
This method does not work in a Node.js environment.
700700

701701
<b>Signature:</b>
702702

@@ -881,7 +881,7 @@ This method sends a code via SMS to the given phone number, and returns a [Confi
881881

882882
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.
883883

884-
This method is not available in Node.js.
884+
This method does not work in a Node.js environment.
885885

886886
<b>Signature:</b>
887887

@@ -919,7 +919,7 @@ Authenticates a Firebase client using a popup-based OAuth authentication flow.
919919

920920
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.
921921

922-
This method is not available in Node.js.
922+
This method does not work in a Node.js environment.
923923

924924
<b>Signature:</b>
925925

@@ -961,7 +961,7 @@ Authenticates a Firebase client using a full-page redirect flow.
961961

962962
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)<!-- -->.
963963

964-
This method is not available in Node.js.
964+
This method does not work in a Node.js environment.
965965

966966
<b>Signature:</b>
967967

@@ -1214,7 +1214,7 @@ Promise&lt;[UserCredential](./auth.usercredential.md#usercredential_interface)<!
12141214

12151215
Links the user account with the given phone number.
12161216

1217-
This method is not available in Node.js.
1217+
This method does not work in a Node.js environment.
12181218

12191219
<b>Signature:</b>
12201220

@@ -1240,7 +1240,7 @@ Links the authenticated provider to the user account using a pop-up based OAuth
12401240

12411241
If the linking is successful, the returned result will contain the user and the provider's credential.
12421242

1243-
This method is not available in Node.js.
1243+
This method does not work in a Node.js environment.
12441244

12451245
<b>Signature:</b>
12461246

@@ -1278,7 +1278,7 @@ Links the [OAuthProvider](./auth.oauthprovider.md#oauthprovider_class) to the us
12781278

12791279
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)<!-- -->.
12801280

1281-
This method is not available in Node.js.
1281+
This method does not work in a Node.js environment.
12821282

12831283
<b>Signature:</b>
12841284

@@ -1365,7 +1365,7 @@ Re-authenticates a user using a fresh phone credential.
13651365

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

1368-
This method is not available in Node.js.
1368+
This method does not work in a Node.js environment.
13691369

13701370
<b>Signature:</b>
13711371

@@ -1391,7 +1391,7 @@ Reauthenticates the current user with the specified [OAuthProvider](./auth.oauth
13911391

13921392
If the reauthentication is successful, the returned result will contain the user and the provider's credential.
13931393

1394-
This method is not available in Node.js.
1394+
This method does not work in a Node.js environment.
13951395

13961396
<b>Signature:</b>
13971397

@@ -1429,7 +1429,7 @@ Reauthenticates the current user with the specified [OAuthProvider](./auth.oauth
14291429

14301430
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)<!-- -->.
14311431

1432-
This method is not available in Node.js.
1432+
This method does not work in a Node.js environment.
14331433

14341434
<b>Signature:</b>
14351435

@@ -1607,7 +1607,7 @@ Promise&lt;void&gt;
16071607

16081608
Updates the user's phone number.
16091609

1610-
This method is not available in Node.js.
1610+
This method does not work in a Node.js environment.
16111611

16121612
<b>Signature:</b>
16131613

@@ -1879,7 +1879,7 @@ browserLocalPersistence: Persistence
18791879

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

1882-
This method is not available in Node.js.
1882+
This method does not work in a Node.js environment.
18831883

18841884
<b>Signature:</b>
18851885

‎docs-devsite/auth.phoneauthprovider.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ https://github.com/firebase/firebase-js-sdk
1212
# PhoneAuthProvider class
1313
Provider for generating an [PhoneAuthCredential](./auth.phoneauthcredential.md#phoneauthcredential_class)<!-- -->.
1414

15-
`PhoneAuthProvider` is not available in Node.js.
15+
`PhoneAuthProvider` does not work in a Node.js environment.
1616

1717
<b>Signature:</b>
1818

‎docs-devsite/auth.phonemultifactorgenerator.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ 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.
47+
This method does not work in a Node.js environment.
4848

4949
<b>Signature:</b>
5050

‎docs-devsite/auth.recaptchaverifier.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ 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.
15+
`RecaptchaVerifier` does not work in a Node.js environment.
1616

1717
<b>Signature:</b>
1818

‎docs-devsite/index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ https://github.com/firebase/firebase-js-sdk
1515

1616
| Package | Description |
1717
| --- | --- |
18-
| [@firebase/analytics](./analytics.md#analytics_package) | The Firebase Analytics Web SDK. This SDK does not work in Node.js. |
18+
| [@firebase/analytics](./analytics.md#analytics_package) | The Firebase Analytics Web SDK. This SDK does not work in a Node.js environment. |
1919
| [@firebase/app](./app.md#app_package) | Firebase App |
2020
| [@firebase/app-check](./app-check.md#app-check_package) | The Firebase App Check Web SDK. |
2121
| [@firebase/auth](./auth.md#auth_package) | Firebase Authentication |
2222
| [@firebase/database](./database.md#database_package) | Firebase Realtime Database |
2323
| [@firebase/firestore](./firestore.md#firestore_package) | Cloud Firestore |
2424
| [@firebase/functions](./functions.md#functions_package) | Cloud Functions for Firebase |
25-
| [@firebase/installations](./installations.md#installations_package) | The Firebase Installations Web SDK. This SDK does not work in Node.js. |
26-
| [@firebase/messaging](./messaging.md#messaging_package) | The Firebase Cloud Messaging Web SDK. This SDK does not work in Node.js. |
27-
| [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK. This SDK does not work in Node.js. |
28-
| [@firebase/remote-config](./remote-config.md#remote-config_package) | The Firebase Remote Config Web SDK. This SDK does not work in Node.js. |
25+
| [@firebase/installations](./installations.md#installations_package) | The Firebase Installations Web SDK. This SDK does not work in a Node.js environment. |
26+
| [@firebase/messaging](./messaging.md#messaging_package) | The Firebase Cloud Messaging Web SDK. This SDK does not work in a Node.js environment. |
27+
| [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment. |
28+
| [@firebase/remote-config](./remote-config.md#remote-config_package) | The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environment. |
2929
| [@firebase/storage](./storage.md#storage_package) | Cloud Storage for Firebase |
3030

‎docs-devsite/installations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# installations package
13-
The Firebase Installations Web SDK. This SDK does not work in Node.js.
13+
The Firebase Installations Web SDK. This SDK does not work in a Node.js environment.
1414

1515
## Functions
1616

‎docs-devsite/messaging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# messaging package
13-
The Firebase Cloud Messaging Web SDK. This SDK does not work in Node.js.
13+
The Firebase Cloud Messaging Web SDK. This SDK does not work in a Node.js environment.
1414

1515
| Entry Point | Description |
1616
| --- | --- |

‎docs-devsite/performance.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# performance package
13-
The Firebase Performance Monitoring Web SDK. This SDK does not work in Node.js.
13+
The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment.
1414

1515
## Functions
1616

‎docs-devsite/remote-config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# remote-config package
13-
The Firebase Remote Config Web SDK. This SDK does not work in Node.js.
13+
The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environment.
1414

1515
## Functions
1616

‎packages/analytics/src/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* The Firebase Analytics Web SDK.
3-
* This SDK does not work in Node.js.
3+
* This SDK does not work in a Node.js environment.
44
*
55
* @packageDocumentation
66
*/

‎packages/app-check/src/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* The Firebase App Check Web SDK.
33
*
44
* @remarks
5-
* Firebase App Check does not work in Node.js using `ReCaptchaV3Provider` or
5+
* Firebase App Check does not work in a Node.js environment using `ReCaptchaV3Provider` or
66
* `ReCaptchaEnterpriseProvider`, but can be used in Node.js if you use
77
* `CustomProvider` and write your own attestation method.
88
*

‎packages/auth/src/core/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export {
4444
* remembered or not. It also makes it easier to never persist the `Auth` state for applications
4545
* that are shared by other users or have sensitive data.
4646
*
47-
* This method has no effect in Node.js.
47+
* This method does not work in a Node.js environment.
4848
*
4949
* @example
5050
* ```javascript

‎packages/auth/src/model/public_types.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ export interface Auth {
194194
* remembered or not. It also makes it easier to never persist the Auth state for applications
195195
* that are shared by other users or have sensitive data.
196196
*
197-
* This method has no effect in Node.js.
197+
* This method does not work in a Node.js environment.
198198
*
199199
* @example
200200
* ```javascript

‎packages/auth/src/platform_browser/mfa/assertions/phone.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ export class PhoneMultiFactorGenerator {
8585
* Provides a {@link PhoneMultiFactorAssertion} to confirm ownership of the phone second factor.
8686
*
8787
* @remarks
88-
* This method is not available in Node.js.
88+
* This method does not work in a Node.js environment.
8989
*
9090
* @param phoneAuthCredential - A credential provided by {@link PhoneAuthProvider.credential}.
9191
* @returns A {@link PhoneMultiFactorAssertion} which can be used with

‎packages/auth/src/platform_browser/popup_redirect.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ class BrowserPopupRedirectResolver implements PopupRedirectResolverInternal {
191191
* based applications.
192192
*
193193
* @remarks
194-
* This method is not available in Node.js.
194+
* This method does not work in a Node.js environment.
195195
*
196196
* @public
197197
*/

‎packages/auth/src/platform_browser/providers/phone.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ import { ProviderId, SignInMethod } from '../../model/enums';
3838
* Provider for generating an {@link PhoneAuthCredential}.
3939
*
4040
* @remarks
41-
* `PhoneAuthProvider` is not available in Node.js.
41+
* `PhoneAuthProvider` does not work in a Node.js environment.
4242
*
4343
* @example
4444
* ```javascript

‎packages/auth/src/platform_browser/recaptcha/recaptcha_verifier.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ type TokenCallback = (token: string) => void;
4545
* An {@link https://www.google.com/recaptcha/ | reCAPTCHA}-based application verifier.
4646
*
4747
* @remarks
48-
* `RecaptchaVerifier` is not available in Node.js.
48+
* `RecaptchaVerifier` does not work in a Node.js environment.
4949
*
5050
* @public
5151
*/

‎packages/auth/src/platform_browser/strategies/phone.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ class ConfirmationResultImpl implements ConfirmationResult {
8282
* {@link RecaptchaVerifier} (like React Native), but you need to use a
8383
* third-party {@link ApplicationVerifier} implementation.
8484
*
85-
* This method is not available in Node.js.
85+
* This method does not work in a Node.js environment.
8686
*
8787
* @example
8888
* ```javascript
@@ -119,7 +119,7 @@ export async function signInWithPhoneNumber(
119119
* Links the user account with the given phone number.
120120
*
121121
* @remarks
122-
* This method is not available in Node.js.
122+
* This method does not work in a Node.js environment.
123123
*
124124
* @param user - The user.
125125
* @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101).
@@ -150,7 +150,7 @@ export async function linkWithPhoneNumber(
150150
* @remarks
151151
* Use before operations such as {@link updatePassword} that require tokens from recent sign-in attempts.
152152
*
153-
* This method is not available in Node.js.
153+
* This method does not work in a Node.js environment.
154154
*
155155
* @param user - The user.
156156
* @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101).
@@ -259,7 +259,7 @@ export async function _verifyPhoneNumber(
259259
* Updates the user's phone number.
260260
*
261261
* @remarks
262-
* This method is not available in Node.js.
262+
* This method does not work in a Node.js environment.
263263
*
264264
* @example
265265
* ```

‎packages/auth/src/platform_browser/strategies/popup.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export const _POLL_WINDOW_CLOSE_TIMEOUT = new Delay(2000, 10000);
6363
* If succeeds, returns the signed in user along with the provider's credential. If sign in was
6464
* unsuccessful, returns an error object containing additional information about the error.
6565
*
66-
* This method is not available in Node.js.
66+
* This method does not work in a Node.js environment.
6767
*
6868
* @example
6969
* ```javascript
@@ -111,7 +111,7 @@ export async function signInWithPopup(
111111
* If the reauthentication is successful, the returned result will contain the user and the
112112
* provider's credential.
113113
*
114-
* This method is not available in Node.js.
114+
* This method does not work in a Node.js environment.
115115
*
116116
* @example
117117
* ```javascript
@@ -154,7 +154,7 @@ export async function reauthenticateWithPopup(
154154
* @remarks
155155
* If the linking is successful, the returned result will contain the user and the provider's credential.
156156
*
157-
* This method is not available in Node.js.
157+
* This method does not work in a Node.js environment.
158158
*
159159
* @example
160160
* ```javascript

‎packages/auth/src/platform_browser/strategies/redirect.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ import { getModularInstance } from '@firebase/util';
4545
* Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
4646
* | best practices} when using {@link signInWithRedirect}.
4747
*
48-
* This method is not available in Node.js.
48+
* This method does not work in a Node.js environment.
4949
*
5050
* @example
5151
* ```javascript
@@ -116,7 +116,7 @@ export async function _signInWithRedirect(
116116
* Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
117117
* | best practices} when using {@link reauthenticateWithRedirect}.
118118
*
119-
* This method is not available in Node.js.
119+
* This method does not work in a Node.js environment.
120120
*
121121
* @example
122122
* ```javascript
@@ -185,7 +185,7 @@ export async function _reauthenticateWithRedirect(
185185
* Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
186186
* | best practices} when using {@link linkWithRedirect}.
187187
*
188-
* This method is not available in Node.js.
188+
* This method does not work in a Node.js environment.
189189
*
190190
* @example
191191
* ```javascript
@@ -247,7 +247,7 @@ export async function _linkWithRedirect(
247247
* If sign-in succeeded, returns the signed in user. If sign-in was unsuccessful, fails with an
248248
* error. If no redirect operation was called, returns `null`.
249249
*
250-
* This method is not available in Node.js.
250+
* This method does not work in a Node.js environment.
251251
*
252252
* @example
253253
* ```javascript

0 commit comments

Comments
 (0)