Skip to content

Commit 6b8d105

Browse files
committed
Fix #239
1 parent db70828 commit 6b8d105

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

auth/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The `useAuthState` hook takes the following parameters:
4545

4646
Returns:
4747

48-
- `user`: The `auth.User` if logged in, or `null` if not
48+
- `user`: The `auth.UserCredential` if logged in, or `null` if not
4949
- `loading`: A `boolean` to indicate whether the authentication state is still being loaded
5050
- `error`: Any `AuthError` returned by Firebase when trying to load the user, or `undefined` if there is no error
5151

@@ -86,7 +86,7 @@ const CurrentUser = () => {
8686
if (user) {
8787
return (
8888
<div>
89-
<p>Current User: {user.email}</p>
89+
<p>Current User: {user.user.email}</p>
9090
<button onClick={logout}>Log out</button>
9191
</div>
9292
);
@@ -118,7 +118,7 @@ The `useCreateUserWithEmailAndPassword` hook takes the following parameters:
118118
Returns:
119119

120120
- `createUserWithEmailAndPassword(email: string, password: string)`: a function you can call to start the registration
121-
- `user`: The `User` if the user was created or `undefined` if not
121+
- `user`: The `auth.UserCredential` if the user was created or `undefined` if not
122122
- `loading`: A `boolean` to indicate whether the the user creation is processing
123123
- `error`: Any `Error` returned by Firebase when trying to create the user, or `undefined` if there is no error
124124

@@ -150,7 +150,7 @@ const SignIn = () => {
150150
if (user) {
151151
return (
152152
<div>
153-
<p>Registered User: {user.email}</p>
153+
<p>Registered User: {user.user.email}</p>
154154
</div>
155155
);
156156
}
@@ -636,7 +636,9 @@ const UpdateProfile = () => {
636636
### useVerifyBeforeUpdateEmail
637637

638638
```js
639-
const [verifyBeforeUpdateEmail, updating, error] = useVerifyBeforeUpdateEmail(auth);
639+
const [verifyBeforeUpdateEmail, updating, error] = useVerifyBeforeUpdateEmail(
640+
auth
641+
);
640642
```
641643

642644
Verify and update the current user's email address. Wraps the underlying `auth.verifyBeforeUpdateEmail` method and provides additional `updating` and `error` information.
@@ -658,7 +660,9 @@ import { useVerifyBeforeUpdateEmail } from 'react-firebase-hooks/auth';
658660

659661
const UpdateEmail = () => {
660662
const [email, setEmail] = useState('');
661-
const [verifyBeforeUpdateEmail, updating, error] = useVerifyBeforeUpdateEmail(auth);
663+
const [verifyBeforeUpdateEmail, updating, error] = useVerifyBeforeUpdateEmail(
664+
auth
665+
);
662666

663667
if (error) {
664668
return (

0 commit comments

Comments
 (0)