Skip to content

Commit cf07c73

Browse files
Apply suggestions from code review
Co-authored-by: Kevin Cheung <[email protected]>
1 parent 4557fbe commit cf07c73

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

packages/app-check-types/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ export interface FirebaseAppCheck {
3131

3232
/**
3333
*
34-
* @param isTokenAutoRefreshEnabled - If set to true, enables SDK to
35-
* automatically refresh AppCheck token as needed. If false, disables this
36-
* functionality. This overrides any value set during `activate()`.
34+
* @param isTokenAutoRefreshEnabled - If true, the SDK automatically
35+
* refreshes App Check tokens as needed. This overrides any value set
36+
* during `activate()`.
3737
*/
3838
setTokenAutoRefreshEnabled(isTokenAutoRefreshEnabled: boolean): void;
3939
}
4040

4141
/**
42-
* An AppCheck provider. This may be either the built-in reCAPTCHA provider
42+
* An App Check provider. This can be either the built-in reCAPTCHA provider
4343
* or a custom provider. For more on custom providers, see
4444
* https://firebase.google.com/docs/app-check/web-custom-provider
4545
*/

packages/firebase/index.d.ts

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1469,11 +1469,12 @@ declare namespace firebase.appCheck {
14691469
export interface AppCheck {
14701470
/**
14711471
* Activate AppCheck
1472-
* @param siteKeyOrProvider reCAPTCHA sitekey or custom token provider
1473-
* @param isTokenAutoRefreshEnabled If true, enables SDK to automatically
1474-
* refresh AppCheck token as needed. If undefined, the value will default
1475-
* to the value of `app.automaticDataCollectionEnabled`. That property
1476-
* defaults to false and can be set in the app config.
1472+
* @param siteKeyOrProvider reCAPTCHA v3 site key (public key) or
1473+
* custom token provider.
1474+
* @param isTokenAutoRefreshEnabled If true, the SDK automatically
1475+
* refreshes App Check tokens as needed. If undefined, defaults to the
1476+
* value of `app.automaticDataCollectionEnabled`, which defaults to
1477+
* false and can be set in the app config.
14771478
*/
14781479
activate(
14791480
siteKeyOrProvider: string | AppCheckProvider,
@@ -1482,16 +1483,16 @@ declare namespace firebase.appCheck {
14821483

14831484
/**
14841485
*
1485-
* @param isTokenAutoRefreshEnabled If set to true, enables SDK to
1486-
* automatically refresh AppCheck token as needed. If false, disables this
1487-
* functionality. This overrides any value set during `activate()`.
1486+
* @param isTokenAutoRefreshEnabled If true, the SDK automatically
1487+
* refreshes App Check tokens as needed. This overrides any value set
1488+
* during `activate()`.
14881489
*/
14891490
setTokenAutoRefreshEnabled(isTokenAutoRefreshEnabled: boolean): void;
14901491
}
14911492

14921493
/**
1493-
* An AppCheck provider. This may be either the built-in reCAPTCHA provider
1494-
* or a custom provider. For more on custom providers, see
1494+
* An App Check provider. This can be either the built-in reCAPTCHA
1495+
* provider or a custom provider. For more on custom providers, see
14951496
* https://firebase.google.com/docs/app-check/web-custom-provider
14961497
*/
14971498
interface AppCheckProvider {

0 commit comments

Comments
 (0)