Skip to content

Commit 5f5f751

Browse files
committed
Address some PR comments
1 parent 5dfd5b9 commit 5f5f751

File tree

2 files changed

+28
-24
lines changed

2 files changed

+28
-24
lines changed

packages/auth/src/core/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,8 @@ export function setPersistence(
8080
* Thus, by calling this optional method, you will reduce the latency of future auth flows.
8181
* Loading the reCAPTCHA config early will also enhance the signal collected by reCAPTCHA.
8282
*
83+
* This method does not work in a Node.js environment.
84+
*
8385
* @example
8486
* ```javascript
8587
* initializeRecaptchaConfig(auth);

packages/firebase/compat/index.d.ts

+26-24
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ declare namespace firebase {
426426
* console.</dd>
427427
* </dl>
428428
*
429-
* This does not work in a Node.js environment.
429+
* This method does not work in a Node.js environment.
430430
*
431431
* @example
432432
* ```javascript
@@ -651,7 +651,7 @@ declare namespace firebase {
651651
* console.</dd>
652652
* </dl>
653653
*
654-
* This does not work in a Node.js environment.
654+
* This method does not work in a Node.js environment.
655655
*
656656
* @example
657657
* ```javascript
@@ -701,7 +701,7 @@ declare namespace firebase {
701701
* console.</dd>
702702
* </dl>
703703
*
704-
* This does not work in a Node.js environment.
704+
* This method does not work in a Node.js environment.
705705
*
706706
* @param provider The provider to authenticate.
707707
* The provider has to be an OAuth provider. Non-OAuth providers like {@link
@@ -1237,7 +1237,7 @@ declare namespace firebase {
12371237
* generating notifications if the push message payload has a `notification`
12381238
* parameter.
12391239
*
1240-
* This does not work in a Node.js environment.
1240+
* The Messaging SDK does not work in a Node.js environment.
12411241
*
12421242
* @example
12431243
* ```javascript
@@ -1296,7 +1296,7 @@ declare namespace firebase {
12961296
* The {@link firebase.performance.Performance `Performance`} service does not work with
12971297
* any other app.
12981298
*
1299-
* This does not work in a Node.js environment.
1299+
* The Performance SDK does not work in a Node.js environment.
13001300
*
13011301
* @example
13021302
* ```javascript
@@ -1315,7 +1315,7 @@ declare namespace firebase {
13151315
/**
13161316
* Gets the {@link firebase.remoteConfig.RemoteConfig `RemoteConfig`} instance.
13171317
*
1318-
* This does not work in a Node.js environment.
1318+
* The Remote Config SDK does not work in a Node.js environment.
13191319
*
13201320
* @example
13211321
* ```javascript
@@ -1335,7 +1335,7 @@ declare namespace firebase {
13351335
* `firebase.analytics()` can be called with no arguments to access the default
13361336
* app's {@link firebase.analytics.Analytics `Analytics`} service.
13371337
*
1338-
* This does not work in a Node.js environment.
1338+
* The Analytics SDK does not work in a Node.js environment.
13391339
*
13401340
* @example
13411341
* ```javascript
@@ -1404,7 +1404,7 @@ declare namespace firebase.app {
14041404
* Gets the {@link firebase.installations.Installations `Installations`} service for the
14051405
* current app.
14061406
*
1407-
* This does not work in a Node.js environment.
1407+
* The Installations SDK does not work in a Node.js environment.
14081408
*
14091409
* @example
14101410
* ```javascript
@@ -1418,7 +1418,7 @@ declare namespace firebase.app {
14181418
* Gets the {@link firebase.messaging.Messaging `Messaging`} service for the
14191419
* current app.
14201420
*
1421-
* This does not work in a Node.js environment.
1421+
* The Messaging SDK does not work in a Node.js environment.
14221422
*
14231423
* @example
14241424
* ```javascript
@@ -1490,7 +1490,7 @@ declare namespace firebase.app {
14901490
* Gets the {@link firebase.performance.Performance `Performance`} service for the
14911491
* current app. If the current app is not the default one, throws an error.
14921492
*
1493-
* This does not work in a Node.js environment.
1493+
* The Performance SDK does not work in a Node.js environment.
14941494
*
14951495
* @example
14961496
* ```javascript
@@ -1503,7 +1503,7 @@ declare namespace firebase.app {
15031503
/**
15041504
* Gets the {@link firebase.remoteConfig.RemoteConfig `RemoteConfig`} instance.
15051505
*
1506-
* This does not work in a Node.js environment.
1506+
* The Remote Config SDK does not work in a Node.js environment.
15071507
*
15081508
* @example
15091509
* ```javascript
@@ -1517,7 +1517,7 @@ declare namespace firebase.app {
15171517
* Gets the {@link firebase.analytics.Analytics `Analytics`} service for the
15181518
* current app. If the current app is not the default one, throws an error.
15191519
*
1520-
* This does not work in a Node.js environment.
1520+
* The Analytics SDK does not work in a Node.js environment.
15211521
*
15221522
* @example
15231523
* ```javascript
@@ -1532,7 +1532,9 @@ declare namespace firebase.app {
15321532
}
15331533

15341534
/**
1535-
* This does not work in a Node.js environment.
1535+
* Firebase App Check does not work in a Node.js environment using `ReCaptchaV3Provider` or
1536+
* `ReCaptchaEnterpriseProvider`, but can be used in Node.js if you use
1537+
* `CustomProvider` and write your own attestation method.
15361538
*/
15371539
declare namespace firebase.appCheck {
15381540
/**
@@ -1696,7 +1698,7 @@ declare namespace firebase.appCheck {
16961698
}
16971699

16981700
/**
1699-
* This does not work in a Node.js environment.
1701+
* The Installations SDK does not work in a Node.js environment.
17001702
*/
17011703
declare namespace firebase.installations {
17021704
/**
@@ -1745,7 +1747,7 @@ declare namespace firebase.installations {
17451747
}
17461748

17471749
/**
1748-
* This does not work in a Node.js environment.
1750+
* The Performance SDK does not work in a Node.js environment.
17491751
*/
17501752
declare namespace firebase.performance {
17511753
/**
@@ -1868,7 +1870,7 @@ declare namespace firebase.performance {
18681870
}
18691871

18701872
/**
1871-
* This does not work in a Node.js environment.
1873+
* The Remote Config SDK does not work in a Node.js environment.
18721874
*/
18731875
declare namespace firebase.remoteConfig {
18741876
/**
@@ -2670,7 +2672,7 @@ declare namespace firebase.auth {
26702672
* Firebase console.</dd>
26712673
* </dl>
26722674
*
2673-
* This does not work in a Node.js environment.
2675+
* This method does not work in a Node.js environment.
26742676
*
26752677
* @example
26762678
* ```javascript
@@ -3350,7 +3352,7 @@ declare namespace firebase.auth {
33503352
* console.</dd>
33513353
* </dl>
33523354
*
3353-
* This does not work in a Node.js environment.
3355+
* This method does not work in a Node.js environment.
33543356
*
33553357
* @example
33563358
* ```javascript
@@ -3413,7 +3415,7 @@ declare namespace firebase.auth {
34133415
* console.</dd>
34143416
* </dl>
34153417
*
3416-
* This does not work in a Node.js environment.
3418+
* This method does not work in a Node.js environment.
34173419
*
34183420
* @param provider The provider to authenticate.
34193421
* The provider has to be an OAuth provider. Non-OAuth providers like {@link
@@ -4628,7 +4630,7 @@ declare namespace firebase.auth {
46284630
* An {@link https://www.google.com/recaptcha/ reCAPTCHA}-based application
46294631
* verifier.
46304632
*
4631-
* This does not work in a Node.js environment.
4633+
* This class does not work in a Node.js environment.
46324634
*
46334635
* @param container The reCAPTCHA container parameter. This
46344636
* has different meaning depending on whether the reCAPTCHA is hidden or
@@ -4775,7 +4777,7 @@ declare namespace firebase.auth {
47754777
}
47764778

47774779
/**
4778-
* This does not work in a Node.js environment.
4780+
* The Analytics SDK does not work in a Node.js environment.
47794781
*/
47804782
declare namespace firebase.analytics {
47814783
/**
@@ -7435,7 +7437,7 @@ declare namespace firebase.database.ServerValue {
74357437
}
74367438

74377439
/**
7438-
* This does not work in a Node.js environment.
7440+
* The Messaging SDK does not work in a Node.js environment.
74397441
*/
74407442
declare namespace firebase.messaging {
74417443
/**
@@ -8326,7 +8328,7 @@ declare namespace firebase.firestore {
83268328
* work around a specific network reliability issue, please tell us about
83278329
* it in https://github.com/firebase/firebase-js-sdk/issues/1674.
83288330
*
8329-
* This does not work in a Node.js environment.
8331+
* This setting does not work in a Node.js environment.
83308332
*/
83318333
experimentalForceLongPolling?: boolean;
83328334

@@ -8338,7 +8340,7 @@ declare namespace firebase.firestore {
83388340
* This setting will likely be enabled by default in future releases and cannot be
83398341
* combined with `experimentalForceLongPolling`.
83408342
*
8341-
* This does not work in a Node.js environment.
8343+
* This setting does not work in a Node.js environment.
83428344
*/
83438345
experimentalAutoDetectLongPolling?: boolean;
83448346

0 commit comments

Comments
 (0)