Skip to content

Commit 0e7aed9

Browse files
committed
address review comments.
1 parent 88cc8a6 commit 0e7aed9

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs-devsite/auth.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Project: /docs/reference/js/_project.yaml
1+
Project: /docs/reference/js/_project.yaml
22
Book: /docs/reference/_book.yaml
33
page_type: reference
44

@@ -35,9 +35,8 @@ Firebase Authentication
3535
| [isSignInWithEmailLink(auth, emailLink)](./auth.md#issigninwithemaillink) | Checks if an incoming link is a sign-in with email link suitable for [signInWithEmailLink()](./auth.md#signinwithemaillink)<!-- -->. |
3636
| [onAuthStateChanged(auth, nextOrObserver, error, completed)](./auth.md#onauthstatechanged) | Adds an observer for changes to the user's sign-in state. |
3737
| [onIdTokenChanged(auth, nextOrObserver, error, completed)](./auth.md#onidtokenchanged) | Adds an observer for changes to the signed-in user's ID token. |
38-
| [sendPasswordResetEmail(auth, email, actionCodeSettings)](./auth.md#sendpasswordresetemail) | Sends a password reset email to the given email address. This method does not throw an error when \[Email Enumeration Protection\](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled. |
3938
| [revokeAccessToken(auth, token)](./auth.md#revokeaccesstoken) | Revokes the given access token. Currently only supports Apple OAuth access tokens. |
40-
| [sendPasswordResetEmail(auth, email, actionCodeSettings)](./auth.md#sendpasswordresetemail) | Sends a password reset email to the given email address. |
39+
| [sendPasswordResetEmail(auth, email, actionCodeSettings)](./auth.md#sendpasswordresetemail) | Sends a password reset email to the given email address. This method does not throw an error when \[Email Enumeration Protection\](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled. |
4140
| [sendSignInLinkToEmail(auth, email, actionCodeSettings)](./auth.md#sendsigninlinktoemail) | Sends a sign-in email link to the user with the specified email. |
4241
| [setPersistence(auth, persistence)](./auth.md#setpersistence) | Changes the type of persistence on the [Auth](./auth.auth.md#auth_interface) instance for the currently saved <code>Auth</code> session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests. |
4342
| [signInAnonymously(auth)](./auth.md#signinanonymously) | Asynchronously signs in as an anonymous user. |
@@ -413,7 +412,7 @@ export declare function fetchSignInMethodsForEmail(auth: Auth, email: string): P
413412
| Parameter | Type | Description |
414413
| --- | --- | --- |
415414
| auth | [Auth](./auth.auth.md#auth_interface) | The [Auth](./auth.auth.md#auth_interface) instance. |
416-
| email | string | The user's email address.<!-- -->Deprecated Migrating off of this method is recommended as a security best-practice. |
415+
| email | string | The user's email address.<!-- -->Deprecated. Migrating off of this method is recommended as a security best-practice. Learn more in the Identity Platform documentation for \[Email Enumeration Protection\](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection). |
417416

418417
<b>Returns:</b>
419418

packages/auth/demo/src/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ function onAuthError(error) {
319319
}
320320
if (error.code === 'auth/invalid-credential') {
321321
alertError(
322-
'login credentials invalid. It is possible that the email/password combination does not exist.'
322+
'Login credentials invalid. It is possible that the email/password combination does not exist.'
323323
);
324324
}
325325
}

packages/auth/src/core/strategies/email.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ import { getModularInstance } from '@firebase/util';
4646
* @param auth - The {@link Auth} instance.
4747
* @param email - The user's email address.
4848
*
49-
* Deprecated Migrating off of this method is recommended as a security best-practice.
49+
* Deprecated. Migrating off of this method is recommended as a security best-practice.
50+
* Learn more in the Identity Platform documentation for [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).
5051
* @public
5152
*/
5253
export async function fetchSignInMethodsForEmail(

0 commit comments

Comments
 (0)