Skip to content

fix(docs): clarify usage of resetPassword #803

Closed
@magrinj

Description

@magrinj

Hello,

When I want to implement the resetPassword on my app, I faced against a documentation error.
I'll explain why:
On this link http://react-redux-firebase.com/docs/auth.html#resetpasswordcredentials, the documentation talk about a credential object, with in example this object:

props.firebase.resetPassword({
  email: 'test@test.com',
  password: 'testest1',
  username: 'tester'
})

So, I was a little bit disappointed, because if we follow the documentation the user need to specify his password, if this one want a reset link...

I take a look into firebase documentation and find that, firebase only want the email, so I read the code about this feature in react-redux-firebase and find on this line that only email need to be provided in the credential object.

* @param {string} credentials.email - Credentials for authenticating

I try to execute this function with an object, but apparently the action itself just want an email:

export const resetPassword = (dispatch, firebase, email) => {

If I use resetPassword directly with an email, everything is works fine, but that need to be clarified in the documentations.

What's the behaviour should be ? Just the email string or a credential object in param ? I can make a PR to correct the documentation and this problem when I've my answer

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions