Skip to content

Commit 6175d9b

Browse files
committed
Fix some doc text
1 parent ee89024 commit 6175d9b

File tree

7 files changed

+16
-16
lines changed

7 files changed

+16
-16
lines changed

packages-exp/app-check-exp/src/api.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ declare module '@firebase/component' {
3232
export { ReCaptchaV3Provider, CustomProvider } from './providers';
3333

3434
/**
35-
* Activate AppCheck for the given app. Can be called only once per app.
36-
* @param app - the FirebaseApp to activate AppCheck for
37-
* @param options - Provider implementation that can return an AppCheck token
35+
* Activate App Check for the given app. Can be called only once per app.
36+
* @param app - the FirebaseApp to activate App Check for
37+
* @param options - Provider implementation that can return an App Check token
3838
* @public
3939
*/
4040
export function initializeAppCheck(
@@ -57,8 +57,8 @@ export function initializeAppCheck(
5757
}
5858

5959
/**
60-
* Activate AppCheck
61-
* @param app - Firebase app to activate AppCheck for.
60+
* Activate App Check
61+
* @param app - Firebase app to activate App Check for.
6262
* @param provider - reCAPTCHA v3 provider or
6363
* custom token provider.
6464
* @param isTokenAutoRefreshEnabled - If true, the SDK automatically

packages-exp/app-check-exp/src/errors.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ const ERRORS: ErrorMap<AppCheckError> = {
3434
'You have already called initializeAppCheck() for FirebaseApp {$appName}, ' +
3535
'initializeAppCheck() can only be called once.',
3636
[AppCheckError.USE_BEFORE_ACTIVATION]:
37-
'AppCheck is being used before initializeAppCheck() is called for FirebaseApp {$appName}. ' +
38-
'Please make sure you call initializeAppCheck() before instantiating other Firebase services.',
37+
'App Check is being used before initializeAppCheck() is called for FirebaseApp {$appName}. ' +
38+
'Make sure you call initializeAppCheck() before instantiating other Firebase services.',
3939
[AppCheckError.FETCH_NETWORK_ERROR]:
4040
'Fetch failed to connect to a network. Check Internet connection. ' +
4141
'Original error: {$originalErrorMessage}.',

packages-exp/app-check-exp/src/internal-api.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export function formatDummyToken(
5151
}
5252

5353
/**
54-
* This function will always resolve.
54+
* This function always resolves.
5555
* The result will contain an error field if there is any error.
5656
* In case there is an error, the token field in the result will be populated with a dummy value
5757
*/

packages-exp/app-check-exp/src/providers.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { AppCheckProvider, AppCheckTokenInternal } from './types';
2929

3030
/**
3131
* App Check provider that can obtain a reCAPTCHA V3 token and exchange it
32-
* for an AppCheck token.
32+
* for an AppC heck token.
3333
*
3434
* @public
3535
*/
@@ -42,7 +42,7 @@ export class ReCaptchaV3Provider implements AppCheckProvider {
4242
*/
4343
constructor(private _siteKey: string) {}
4444
/**
45-
* Returns an AppCheck token.
45+
* Returns an App Check token.
4646
* @internal
4747
*/
4848
async getToken(): Promise<AppCheckTokenInternal> {

packages-exp/app-check-exp/src/public-types.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,19 @@ import { FirebaseApp } from '@firebase/app-exp';
1919
import { CustomProvider, ReCaptchaV3Provider } from './providers';
2020

2121
/**
22-
* The Firebase AppCheck service interface.
22+
* The Firebase App Check service interface.
2323
*
2424
* @public
2525
*/
2626
export interface AppCheck {
2727
/**
28-
* The FirebaseApp this Functions instance is associated with.
28+
* The `FirebaseApp` this `AppCheck` instance is associated with.
2929
*/
3030
app: FirebaseApp;
3131
}
3232

3333
/**
34-
* The token returned from an AppCheck provider.
34+
* The token returned from an App Check provider.
3535
* @public
3636
*/
3737
export interface AppCheckToken {
@@ -57,7 +57,7 @@ export interface AppCheckOptions {
5757
*/
5858
provider: CustomProvider | ReCaptchaV3Provider;
5959
/**
60-
* If set to true, enables automatic background refresh of app check token.
60+
* If set to true, enables automatic background refresh of App Check token.
6161
*/
6262
isTokenAutoRefreshEnabled?: boolean;
6363
}

packages-exp/app-check-exp/src/storage.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ export async function readOrCreateDebugTokenFromStorage(): Promise<string> {
8989
);
9090
// Not using logger because I don't think we ever want this accidentally hidden?
9191
console.log(
92-
`AppCheck debug token: ${newToken}. You will need to whitelist it in the Firebase console for it to work`
92+
`App Check debug token: ${newToken}. You will need to whitelist it in the Firebase console for it to work`
9393
);
9494
return newToken;
9595
} else {

packages-exp/app-check-exp/src/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface AppCheckTokenInternal extends AppCheckToken {
4747

4848
export interface AppCheckProvider {
4949
/**
50-
* Returns an AppCheck token.
50+
* Returns an App Check token.
5151
*/
5252
getToken: () => Promise<AppCheckTokenInternal>;
5353
initialize(app: FirebaseApp): void;

0 commit comments

Comments
 (0)