Skip to content

Commit 932244d

Browse files
committed
Wording changes for User operations
1 parent 1c24bb5 commit 932244d

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ export async function linkWithCredential(
110110
* attempts. This method can be used to recover from a `CREDENTIAL_TOO_OLD_LOGIN_AGAIN` error
111111
* or a `TOKEN_EXPIRED` error.
112112
*
113-
* This method is not supported by {@link Auth} instances created with a
114-
* {@link @firebase/app#FirebaseServerApp}.
113+
* This method is not supported on any {@link User} signed in by {@link Auth} instances
114+
* created with a {@link @firebase/app#FirebaseServerApp}.
115115
*
116116
* @param user - The user.
117117
* @param credential - The auth credential.

packages/auth/src/model/public_types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1009,7 +1009,7 @@ export interface User extends UserInfo {
10091009
* signed in. If this requirement isn't met, ask the user to authenticate again and then call
10101010
* one of the reauthentication methods like {@link reauthenticateWithCredential}.
10111011
*
1012-
* This method is not supported for any {@link User} signed in by {@link Auth} instances
1012+
* This method is not supported on any {@link User} signed in by {@link Auth} instances
10131013
* created with a {@link @firebase/app#FirebaseServerApp}.
10141014
*/
10151015
delete(): Promise<void>;

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ export async function linkWithPhoneNumber(
157157
* @remarks
158158
* Use before operations such as {@link updatePassword} that require tokens from recent sign-in attempts.
159159
*
160-
* This method does not work in a Node.js environment or with {@link Auth} instances created with a
161-
* {@link @firebase/app#FirebaseServerApp}.
160+
* This method does not work in a Node.js environment or on any {@link User} signed in by
161+
* {@link Auth} instances created with a {@link @firebase/app#FirebaseServerApp}.
162162
*
163163
* @param user - The user.
164164
* @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101).
@@ -272,8 +272,8 @@ export async function _verifyPhoneNumber(
272272
* Updates the user's phone number.
273273
*
274274
* @remarks
275-
* This method does not work in a Node.js environment or with {@link Auth} instances created with a
276-
* {@link @firebase/app#FirebaseServerApp}.
275+
* This method does not work in a Node.js environment or on any {@link User} signed in by
276+
* {@link Auth} instances created with a {@link @firebase/app#FirebaseServerApp}.
277277
*
278278
* @example
279279
* ```

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,8 @@ export async function signInWithPopup(
118118
* If the reauthentication is successful, the returned result will contain the user and the
119119
* provider's credential.
120120
*
121-
* This method does not work in a Node.js environment or with {@link Auth} instances created with a
122-
* {@link @firebase/app#FirebaseServerApp}.
121+
* This method does not work in a Node.js environment or on any {@link User} signed in by
122+
* {@link Auth} instances created with a {@link @firebase/app#FirebaseServerApp}.
123123
*
124124
* @example
125125
* ```javascript

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ export async function _signInWithRedirect(
124124
* Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
125125
* | best practices} when using {@link reauthenticateWithRedirect}.
126126
*
127-
* This method does not work in a Node.js environment or with {@link Auth} instances created with a
128-
* {@link @firebase/app#FirebaseServerApp}.
127+
* This method does not work in a Node.js environment or with {@link Auth} instances
128+
* created with a {@link @firebase/app#FirebaseServerApp}.
129129
*
130130
* @example
131131
* ```javascript
@@ -199,8 +199,8 @@ export async function _reauthenticateWithRedirect(
199199
* Follow the {@link https://firebase.google.com/docs/auth/web/redirect-best-practices
200200
* | best practices} when using {@link linkWithRedirect}.
201201
*
202-
* This method does not work in a Node.js environment or with {@link Auth} instances created with a
203-
* {@link @firebase/app#FirebaseServerApp}.
202+
* This method does not work in a Node.js environment or with {@link Auth} instances
203+
* created with a {@link @firebase/app#FirebaseServerApp}.
204204
*
205205
* @example
206206
* ```javascript

0 commit comments

Comments
 (0)