Skip to content

Commit 4959195

Browse files
committed
One more pass of feedback
1 parent 688491d commit 4959195

18 files changed

+45
-46
lines changed

docs-exp/auth-types.auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,5 @@ export interface Auth
3535
| [signOut()](./auth-types.auth.signout.md) | Signs out the current user. |
3636
| [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | Asynchronously sets the provided user as <code>currentUser</code> on the Auth instance. A new instance copy of the user provided will be made and set as currentUser.<!-- -->This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods.<!-- -->The operation fails with an error if the user to be updated belongs to a different Firebase project. |
3737
| [useDeviceLanguage()](./auth-types.auth.usedevicelanguage.md) | Sets the current language to the default device/browser preference. |
38-
| [useEmulator(url)](./auth-types.auth.useemulator.md) | Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to <code>firebase.auth()</code>. Do not use with production credentials as emulator traffic is not encrypted. |
38+
| [useEmulator(url)](./auth-types.auth.useemulator.md) | Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to <code>initializeAuth()</code>. Do not use with production credentials as emulator traffic is not encrypted. |
3939

docs-exp/auth-types.auth.onauthstatechanged.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ onAuthStateChanged(
2222

2323
| Parameter | Type | Description |
2424
| --- | --- | --- |
25-
| nextOrObserver | [NextOrObserver](./auth-types.nextorobserver.md)<!-- -->&lt;[User](./auth-types.user.md)<!-- -->&gt; | callback triggere on change. |
25+
| nextOrObserver | [NextOrObserver](./auth-types.nextorobserver.md)<!-- -->&lt;[User](./auth-types.user.md)<!-- -->&gt; | callback triggered on change. |
2626
| error | ErrorFn | callback triggered on error. |
2727
| completed | CompleteFn | callback triggered when observer is removed. |
2828

docs-exp/auth-types.auth.onidtokenchanged.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ onIdTokenChanged(
2020

2121
| Parameter | Type | Description |
2222
| --- | --- | --- |
23-
| nextOrObserver | [NextOrObserver](./auth-types.nextorobserver.md)<!-- -->&lt;[User](./auth-types.user.md)<!-- -->&gt; | callback triggere on change. |
23+
| nextOrObserver | [NextOrObserver](./auth-types.nextorobserver.md)<!-- -->&lt;[User](./auth-types.user.md)<!-- -->&gt; | callback triggered on change. |
2424
| error | ErrorFn | callback triggered on error. |
2525
| completed | CompleteFn | callback triggered when observer is removed. |
2626

docs-exp/auth-types.auth.useemulator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Auth.useEmulator() method
66

7-
Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to `firebase.auth()`<!-- -->. Do not use with production credentials as emulator traffic is not encrypted.
7+
Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to `initializeAuth()`<!-- -->. Do not use with production credentials as emulator traffic is not encrypted.
88

99
<b>Signature:</b>
1010

@@ -16,7 +16,7 @@ useEmulator(url: string): void;
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| url | string | The URL at which the emulator is running (eg, 'http://localhost:9099') |
19+
| url | string | The URL at which the emulator is running (eg, 'http://localhost:9099'). |
2020

2121
<b>Returns:</b>
2222

docs-exp/auth-types.confirmationresult.confirm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Promise&lt;[UserCredential](./auth-types.usercredential.md)<!-- -->&gt;
2727

2828
```javascript
2929
const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
30-
// obtain verificationCode from the user
30+
// Obtain verificationCode from the user.
3131
const userCredential = await confirmationResult.confirm(verificationCode);
3232

3333
```

docs-exp/auth-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
| [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) | Options used for enrolling a second factor. |
5454
| [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) | Options used for signing-in with a second factor. |
5555
| [PhoneSingleFactorInfoOptions](./auth-types.phonesinglefactorinfooptions.md) | Options used for single-factor sign-in. |
56-
| [PopupRedirectResolver](./auth-types.popupredirectresolver.md) | A resolver used for handling DOM specific operations like <code>signInWithPopup()</code> or <code>signInWithRedirect()</code> |
56+
| [PopupRedirectResolver](./auth-types.popupredirectresolver.md) | A resolver used for handling DOM specific operations like <code>signInWithPopup()</code> or <code>signInWithRedirect()</code>. |
5757
| [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) | Interface for a supplied AsyncStorage. |
5858
| [User](./auth-types.user.md) | A user account. |
5959
| [UserCredential](./auth-types.usercredential.md) | A structure containing a [User](./auth-types.user.md)<!-- -->, an [AuthCredential](./auth-types.authcredential.md)<!-- -->, the [OperationType](./auth-types.operationtype.md)<!-- -->, and any additional user information that was returned from the identity provider. <code>operationType</code> could be [OperationType.SIGN\_IN](./auth-types.operationtype.sign_in.md) for a sign-in operation, [OperationType.LINK](./auth-types.operationtype.link.md) for a linking operation and [OperationType.REAUTHENTICATE](./auth-types.operationtype.reauthenticate.md) for a reauthentication operation. |

docs-exp/auth-types.multifactorresolver.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,13 @@ const phoneInfoOptions = {
4545
session: resolver.session
4646
};
4747
const verificationId = phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier);
48-
// store `verificationId` and show UI to let user enter verification code.
48+
// Store `verificationId` and show UI to let user enter verification code.
4949

5050
// UI to enter verification code and continue.
5151
// Continue button click handler
5252
const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
5353
const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential);
5454
const userCredential = await resolver.resolveSignIn(multiFactorAssertion);
55-
// User signed in.
5655

5756
```
5857

docs-exp/auth-types.multifactoruser.enroll.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Promise&lt;void&gt;
3333
const multiFactorUser = multiFactor(auth.currentUser);
3434
const multiFactorSession = await multiFactorUser.getSession();
3535

36-
// Send verification code
36+
// Send verification code.
3737
const phoneAuthProvider = new PhoneAuthProvider(auth);
3838
const phoneInfoOptions = {
3939
phoneNumber: phoneNumber,

docs-exp/auth-types.multifactoruser.getsession.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The promise that resolves with the [MultiFactorSession](./auth-types.multifactor
2424
const multiFactorUser = multiFactor(auth.currentUser);
2525
const multiFactorSession = await multiFactorUser.getSession();
2626

27-
// Send verification code
27+
// Send verification code.
2828
const phoneAuthProvider = new PhoneAuthProvider(auth);
2929
const phoneInfoOptions = {
3030
phoneNumber: phoneNumber,

docs-exp/auth-types.phoneauthprovider.credential.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The auth provider credential.
3434
```javascript
3535
const provider = new PhoneAuthProvider(auth);
3636
const verificationId = provider.verifyPhoneNumber(phoneNumber, applicationVerifier);
37-
// obtain verificationCode from the user
37+
// Obtain verificationCode from the user.
3838
const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
3939
const userCredential = signInWithCredential(auth, authCredential);
4040

@@ -46,7 +46,7 @@ An alternative flow is provided using the `signInWithPhoneNumber` method.
4646

4747
```javascript
4848
const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
49-
// obtain verificationCode from the user
49+
// Obtain verificationCode from the user.
5050
const userCredential = await confirmationResult.confirm(verificationCode);
5151

5252
```

docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ A Promise for the verification ID.
3434
```javascript
3535
const provider = new PhoneAuthProvider(auth);
3636
const verificationId = await provider.verifyPhoneNumber(phoneNumber, applicationVerifier);
37-
// obtain verificationCode from the user
37+
// Obtain verificationCode from the user.
3838
const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
3939
const userCredential = await signInWithCredential(auth, authCredential);
4040

@@ -46,7 +46,7 @@ An alternative flow is provided using the `signInWithPhoneNumber` method.
4646

4747
```javascript
4848
const confirmationResult = signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
49-
// obtain verificationCode from the user
49+
// Obtain verificationCode from the user.
5050
const userCredential = confirmationResult.confirm(verificationCode);
5151

5252
```

docs-exp/auth-types.popupredirectresolver.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## PopupRedirectResolver interface
66

7-
A resolver used for handling DOM specific operations like `signInWithPopup()` or `signInWithRedirect()`
7+
A resolver used for handling DOM specific operations like `signInWithPopup()` or `signInWithRedirect()`<!-- -->.
88

99
<b>Signature:</b>
1010

docs-exp/auth-types.user.getidtoken.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Returns a JSON Web Token (JWT) used to identify the user to a Firebase service.
88

9-
Returns the current token if it has not expired. Otherwise, this will refresh the token and return a new one.
9+
Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one.
1010

1111
<b>Signature:</b>
1212

docs-exp/auth-types.user.getidtokenresult.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
## User.getIdTokenResult() method
66

7-
Returns a de-serialized JSON Web Token (JWT) used to identitfy the user to a Firebase service.
7+
Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service.
88

9-
Returns the current token if it has not expired. Otherwise, this will refresh the token and return a new one.
9+
Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one.
1010

1111
<b>Signature:</b>
1212

docs-exp/auth-types.user.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ export interface User extends UserInfo
2929
| Method | Description |
3030
| --- | --- |
3131
| [delete()](./auth-types.user.delete.md) | Deletes and signs out the user.<!-- -->Important: this is a security-sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call one of the reauthentication methods like <code>reauthenticateWithCredential</code>. |
32-
| [getIdToken(forceRefresh)](./auth-types.user.getidtoken.md) | Returns a JSON Web Token (JWT) used to identify the user to a Firebase service.<!-- -->Returns the current token if it has not expired. Otherwise, this will refresh the token and return a new one. |
33-
| [getIdTokenResult(forceRefresh)](./auth-types.user.getidtokenresult.md) | Returns a de-serialized JSON Web Token (JWT) used to identitfy the user to a Firebase service.<!-- -->Returns the current token if it has not expired. Otherwise, this will refresh the token and return a new one. |
32+
| [getIdToken(forceRefresh)](./auth-types.user.getidtoken.md) | Returns a JSON Web Token (JWT) used to identify the user to a Firebase service.<!-- -->Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. |
33+
| [getIdTokenResult(forceRefresh)](./auth-types.user.getidtokenresult.md) | Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service.<!-- -->Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. |
3434
| [reload()](./auth-types.user.reload.md) | Refreshes the user, if signed in. |
3535
| [toJSON()](./auth-types.user.tojson.md) | Returns a JSON-serializable representation of this object. |
3636

docs-exp/auth-types.userinfo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export interface UserInfo
1919
| [displayName](./auth-types.userinfo.displayname.md) | string \| null | The display name of the user. |
2020
| [email](./auth-types.userinfo.email.md) | string \| null | The email of the user. |
2121
| [phoneNumber](./auth-types.userinfo.phonenumber.md) | string \| null | The phone number normalized based on the E.164 standard (e.g. +16505550101) for the user. This is null if the user has no phone credential linked to the account. |
22-
| [photoURL](./auth-types.userinfo.photourl.md) | string \| null | The profile photo URL of the user |
22+
| [photoURL](./auth-types.userinfo.photourl.md) | string \| null | The profile photo URL of the user. |
2323
| [providerId](./auth-types.userinfo.providerid.md) | string | The provider used to authenticate the user. |
2424
| [uid](./auth-types.userinfo.uid.md) | string | The user's unique ID, scoped to the project. |
2525

docs-exp/auth-types.userinfo.photourl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## UserInfo.photoURL property
66

7-
The profile photo URL of the user
7+
The profile photo URL of the user.
88

99
<b>Signature:</b>
1010

0 commit comments

Comments
 (0)