CSFrequency / react-firebase-hooks

React Hooks for Firebase.
Apache License 2.0
3.58k stars 304 forks source link

Error in documentation of useSignInWithEmailAndPassword #239

Closed a-barbieri closed 1 year ago

a-barbieri commented 2 years ago

https://github.com/CSFrequency/react-firebase-hooks/blob/edab3f3f3b5ec01c8aafcc6096755dfcc69e4408/auth/README.md?plain=1#L150

In the docs you use user.email but useSignInWithEmailAndPassword returns UserCredential type not User. The correct use should be user.user.email. It might be good to rename it then...

a-barbieri commented 2 years ago

The same goes for useCreateUserWithEmailAndPassword

chrisbianca commented 1 year ago

Thanks @a-barbieri, I have updated the documentation