Skip to content

Commit 688491d

Browse files
committed
Fix typo and remove stray hyphen
1 parent 7b26c90 commit 688491d

8 files changed

+16
-16
lines changed

docs-exp/auth-types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@
5050
| [ParsedToken](./auth-types.parsedtoken.md) | Parsed ID token. |
5151
| [Persistence](./auth-types.persistence.md) | An enumeration of the possible persistence mechanism types. |
5252
| [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) | The class for asserting ownership of a phone second factor. Provided by [PhoneMultiFactorGenerator.assertion()](./auth-types.phonemultifactorgenerator.assertion.md)<!-- -->. |
53-
| [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) | Options used for enrolling a second-factor. |
54-
| [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) | Options used for signing-in with a second-factor. |
53+
| [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) | Options used for enrolling a second factor. |
54+
| [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. |
5656
| [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. |

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

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

55
## MultiFactorError.credential property
66

7-
The original redential used as a first-factor.
7+
The original credential used as a first factor.
88

99
<b>Signature:</b>
1010

docs-exp/auth-types.multifactorerror.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ signInWithEmailAndPassword(auth, email, password)
3333
}
3434
});
3535

36-
// Obtain a multiFactorAssertion by verifying the second-factor.
36+
// Obtain a multiFactorAssertion by verifying the second factor.
3737

3838
const userCredential = await resolver.resolveSignIn(multiFactorAssertion);
3939

@@ -43,6 +43,6 @@ const userCredential = await resolver.resolveSignIn(multiFactorAssertion);
4343
4444
| Property | Type | Description |
4545
| --- | --- | --- |
46-
| [credential](./auth-types.multifactorerror.credential.md) | [AuthCredential](./auth-types.authcredential.md) | The original redential used as a first-factor. |
46+
| [credential](./auth-types.multifactorerror.credential.md) | [AuthCredential](./auth-types.authcredential.md) | The original credential used as a first factor. |
4747
| [operationType](./auth-types.multifactorerror.operationtype.md) | [OperationType](./auth-types.operationtype.md) | The type of operation (e.g., sign-in, link, or reauthenticate) during which the error was raised. |
4848

docs-exp/auth-types.multifactorresolver.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ signInWithEmailAndPassword(auth, email, password)
3939
// from that list.
4040

4141
const selectedHint = // ; selected from multiFactorHints
42-
const phoneAuthProvider = new PhoneAuthProvider();
42+
const phoneAuthProvider = new PhoneAuthProvider(auth);
4343
const phoneInfoOptions = {
4444
multiFactorHint: selectedHint,
4545
session: resolver.session

docs-exp/auth-types.phonemultifactorenrollinfooptions.md

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

55
## PhoneMultiFactorEnrollInfoOptions interface
66

7-
Options used for enrolling a second-factor.
7+
Options used for enrolling a second factor.
88

99
<b>Signature:</b>
1010

docs-exp/auth-types.phonemultifactorsignininfooptions.md

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

55
## PhoneMultiFactorSignInInfoOptions interface
66

7-
Options used for signing-in with a second-factor.
7+
Options used for signing-in with a second factor.
88

99
<b>Signature:</b>
1010

@@ -17,6 +17,6 @@ export interface PhoneMultiFactorSignInInfoOptions
1717
| Property | Type | Description |
1818
| --- | --- | --- |
1919
| [multiFactorHint](./auth-types.phonemultifactorsignininfooptions.multifactorhint.md) | [MultiFactorInfo](./auth-types.multifactorinfo.md) | The [MultiFactorInfo](./auth-types.multifactorinfo.md) obtained via [MultiFactorResolver.hints](./auth-types.multifactorresolver.hints.md)<!-- -->.<!-- -->One of <code>multiFactorHint</code> or <code>multiFactorUid</code> is required. |
20-
| [multiFactorUid](./auth-types.phonemultifactorsignininfooptions.multifactoruid.md) | string | The uid of the second-factor.<!-- -->One of <code>multiFactorHint</code> or <code>multiFactorUid</code> is required. |
20+
| [multiFactorUid](./auth-types.phonemultifactorsignininfooptions.multifactoruid.md) | string | The uid of the second factor.<!-- -->One of <code>multiFactorHint</code> or <code>multiFactorUid</code> is required. |
2121
| [session](./auth-types.phonemultifactorsignininfooptions.session.md) | [MultiFactorSession](./auth-types.multifactorsession.md) | The [MultiFactorSession](./auth-types.multifactorsession.md) obtained via [MultiFactorResolver.session](./auth-types.multifactorresolver.session.md)<!-- -->. |
2222

docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md

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

55
## PhoneMultiFactorSignInInfoOptions.multiFactorUid property
66

7-
The uid of the second-factor.
7+
The uid of the second factor.
88

99
One of `multiFactorHint` or `multiFactorUid` is required.
1010

packages-exp/auth-types-exp/index.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -896,7 +896,7 @@ export interface MultiFactorAssertion {
896896
* }
897897
* });
898898
*
899-
* // Obtain a multiFactorAssertion by verifying the second-factor.
899+
* // Obtain a multiFactorAssertion by verifying the second factor.
900900
*
901901
* const userCredential = await resolver.resolveSignIn(multiFactorAssertion);
902902
* ```
@@ -905,7 +905,7 @@ export interface MultiFactorAssertion {
905905
*/
906906
export interface MultiFactorError extends AuthError {
907907
/**
908-
* The original redential used as a first-factor.
908+
* The original credential used as a first factor.
909909
*/
910910
readonly credential: AuthCredential;
911911
/**
@@ -959,7 +959,7 @@ export interface MultiFactorInfo {
959959
* // from that list.
960960
*
961961
* const selectedHint = // ; selected from multiFactorHints
962-
* const phoneAuthProvider = new PhoneAuthProvider();
962+
* const phoneAuthProvider = new PhoneAuthProvider(auth);
963963
* const phoneInfoOptions = {
964964
* multiFactorHint: selectedHint,
965965
* session: resolver.session
@@ -1158,7 +1158,7 @@ export interface PhoneSingleFactorInfoOptions {
11581158
}
11591159

11601160
/**
1161-
* Options used for enrolling a second-factor.
1161+
* Options used for enrolling a second factor.
11621162
*
11631163
* @public
11641164
*/
@@ -1169,7 +1169,7 @@ export interface PhoneMultiFactorEnrollInfoOptions {
11691169
session: MultiFactorSession;
11701170
}
11711171
/**
1172-
* Options used for signing-in with a second-factor.
1172+
* Options used for signing-in with a second factor.
11731173
*
11741174
* @public
11751175
*/
@@ -1181,7 +1181,7 @@ export interface PhoneMultiFactorSignInInfoOptions {
11811181
*/
11821182
multiFactorHint?: MultiFactorInfo;
11831183
/**
1184-
* The uid of the second-factor.
1184+
* The uid of the second factor.
11851185
*
11861186
* One of `multiFactorHint` or `multiFactorUid` is required.
11871187
*/

0 commit comments

Comments
 (0)