Skip to content

Commit 512b475

Browse files
authored
Update README.md
1 parent 32acbff commit 512b475

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

auth/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -762,7 +762,7 @@ The `useSignOut` hook takes the following parameters:
762762
Returns:
763763

764764
- `signOut()`: A `() => Promise<void>` function you can call to sign out current user
765-
- `loading`: A `boolean` to indicate whether operation is loading
765+
- `loading`: A `boolean` to indicate whether the user is being signed out
766766
- `error`: Any `Error` returned by Firebase when trying to sign out user, or `undefined` if there is no error
767767

768768
#### Full Example
@@ -804,16 +804,16 @@ const SignOut = () => {
804804
const [deleteUser, loading, error] = useDeleteUser(auth);
805805
```
806806

807-
Delete current user. Wraps the underlying `auth.currrentUser.signOut` method and provides additional `loading` and `error` information.
807+
Delete current user. Wraps the underlying `auth.currrentUser.delete` method and provides additional `loading` and `error` information.
808808

809809
The `useDeleteUser` hook takes the following parameters:
810810

811811
- `auth`: `Auth` instance for the app you would like to monitor
812812

813813
Returns:
814814

815-
- `deleteUser()`: A `() => Promise<void>` function you can call to sign out current user
816-
- `loading`: A `boolean` to indicate whether operation is loading
815+
- `deleteUser()`: A `() => Promise<void>` function you can call to delete the current user
816+
- `loading`: A `boolean` to indicate whether the deletion is processing
817817
- `error`: Any `Error` returned by Firebase when trying to delete user, or `undefined` if there is no error
818818

819819
#### Full Example

0 commit comments

Comments
 (0)