Skip to content

Commit cd92522

Browse files
authored
Reference the signInWithRedirect best practices in docs (#6927)
Fix a typo in the reauthenticateWithRedirect example.
1 parent 1455bfa commit cd92522

File tree

1 file changed

+9
-2
lines changed
  • packages/auth/src/platform_browser/strategies

1 file changed

+9
-2
lines changed

packages/auth/src/platform_browser/strategies/redirect.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ import { getModularInstance } from '@firebase/util';
4242
*
4343
* @remarks
4444
* To handle the results and errors for this operation, refer to {@link getRedirectResult}.
45+
* Follow the [best practices](https://firebase.google.com/docs/auth/web/redirect-best-practices) when using {@link signInWithRedirect}.
4546
*
4647
* @example
4748
* ```javascript
@@ -103,6 +104,9 @@ export async function _signInWithRedirect(
103104

104105
/**
105106
* Reauthenticates the current user with the specified {@link OAuthProvider} using a full-page redirect flow.
107+
* @remarks
108+
* To handle the results and errors for this operation, refer to {@link getRedirectResult}.
109+
* Follow the [best practices](https://firebase.google.com/docs/auth/web/redirect-best-practices) when using {@link reauthenticateWithRedirect}.
106110
*
107111
* @example
108112
* ```javascript
@@ -113,8 +117,8 @@ export async function _signInWithRedirect(
113117
*
114118
* // After returning from the redirect when your app initializes you can obtain the result
115119
* const result = await getRedirectResult(auth);
116-
* // Link using a redirect.
117-
* await linkWithRedirect(result.user, provider);
120+
* // Reauthenticate using a redirect.
121+
* await reauthenticateWithRedirect(result.user, provider);
118122
* // This will again trigger a full page redirect away from your app
119123
*
120124
* // After returning from the redirect when your app initializes you can obtain the result
@@ -162,6 +166,9 @@ export async function _reauthenticateWithRedirect(
162166

163167
/**
164168
* Links the {@link OAuthProvider} to the user account using a full-page redirect flow.
169+
* @remarks
170+
* To handle the results and errors for this operation, refer to {@link getRedirectResult}.
171+
* Follow the [best practices](https://firebase.google.com/docs/auth/web/redirect-best-practices) when using {@link linkWithRedirect}.
165172
*
166173
* @example
167174
* ```javascript

0 commit comments

Comments
 (0)