Skip to content

Commit d00a542

Browse files
committed
Clarify updateUser docs
1 parent 29f3b15 commit d00a542

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

API.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Only `MockFirebase` methods are included here. For details on normal Firebase AP
1515
- [`changeAuthState(user)`](#changeauthstateuser---undefined)
1616
- [`getUserByEmail(email)`](#getuserbyemailemail---promiseobject)
1717
- [`getUser(uid)`](#getuseruid---promiseobject)
18-
- [`updateUser(user)`](#updateuseruser---promiseobject)
18+
- [`updateUser(user)`](#updateuseruser---promisemockuser)
1919
- [Server Timestamps](#server-timestamps)
2020
- [`setClock(fn)`](#firebasesetclockfn---undefined)
2121
- [`restoreClock()`](#firebasesetclockfn---undefined)
@@ -222,10 +222,10 @@ Finds a user previously created with [`createUser`](https://www.firebase.com/doc
222222

223223
Finds a user previously created with [`createUser`](https://www.firebase.com/docs/web/api/firebase/createuser.html). If no user was created with the specified `email`, the promise is rejected.
224224

225-
##### `updateUser(user)` -> `Promise<Object>`
225+
##### `updateUser(user)` -> `Promise<MockUser>`
226226

227227
Replace the existing user with a new one, by matching uid. Throws an
228-
error If no user exists whose uid matches the given user's uid. Resolves
228+
error if no user exists whose uid matches the given user's uid. Resolves
229229
with the updated user when complete. This operation is queued until the
230230
next flush.
231231

0 commit comments

Comments
 (0)