fix(types): fix arguments in resetPassword - #803 - @magrinj

fix(docs): documentation about resetPassword - #803 - @magrinj

Author: prescottprue

docs/api/firebaseInstance.md

@@ -449,8 +449,7 @@ Sends password reset email
 
 ### Parameters
 
--   `credentials` **[object][66]** Credentials for authenticating
-    -   `credentials.email` **[string][69]** Credentials for authenticating
+-   `email` **[string][69]** Email to send recovery email to
 
 Returns **[Promise][72]** Resolves after password reset email is sent
 

docs/auth.md

@@ -204,22 +204,17 @@ Looking to preserve data on logout? [checkout the `preserve` config option](/doc
 props.firebase.logout()
 ```
 
-## resetPassword(credentials)
+## resetPassword(email)
 Calls Firebase's `firebase.auth().resetPassword()`. If there is an error, it is added into redux state under `state.firebase.authError`.
 
 ##### Examples
 
 ```js
-props.firebase.resetPassword({
-  email: '[email protected]',
-  password: 'testest1',
-  username: 'tester'
-})
+props.firebase.resetPassword('[email protected]')
 ```
 
 ##### Parameters
-  * `credentials` [**Object**][object-url] - Credentials same as described in firebase docs
-  * `profile` [**Object**][object-url] - if initialized with userProfile support then profile will be saved into `${userProfile}/${auth.uid}`
+  * `email` [**String**][string-url] - Email to send recovery email to
 
 ##### Returns
   [**Promise**][promise-url] with user's UID in case of success or the error otherwise.

index.d.ts

@@ -620,13 +620,10 @@ interface ExtendedAuthInstance {
 
   /**
    * Sends password reset email.
-   * @param credentials - Credentials for authenticating
+   * @param email - Email to send recovery email to
    * @see https://react-redux-firebase.com/docs/auth.html#resetpasswordcredentials
    */
-  resetPassword: (
-    credentials: AuthTypes.UserCredential,
-    profile: UserProfile
-  ) => Promise<any>
+  resetPassword: (email: string) => Promise<any>
 
   /**
    * Confirm that a user's password has been reset.

src/createFirebaseInstance.js

@@ -429,13 +429,12 @@ export default function createFirebaseInstance(firebase, configs, dispatch) {
 
   /**
    * Sends password reset email
-   * @param {object} credentials - Credentials for authenticating
-   * @param {string} credentials.email - Credentials for authenticating
+   * @param {string} email - Email to send recovery email to
    * @returns {Promise} Resolves after password reset email is sent
    * @see https://react-redux-firebase.com/docs/api/firebaseInstance.html#resetpassword
    */
-  const resetPassword = credentials =>
-    authActions.resetPassword(dispatch, firebase, credentials)
+  const resetPassword = email =>
+    authActions.resetPassword(dispatch, firebase, email)
 
   /**
    * Confirm that a user's password has been reset

test/unit/createFirebaseInstance.spec.js

@@ -548,11 +548,7 @@ describe('createFirebaseInstance', () => {
 
       expect(firebaseInstance.resetPassword).to.be.a.function
       const email = '[email protected]'
-      const password = 'asdfasdf1'
-      await firebaseInstance.resetPassword({
-        email,
-        password
-      })
+      await firebaseInstance.resetPassword(email)
       // signInWithEmailAndPassword is called on resetPassword with email
       expect(resetPasswordSpy).to.have.been.calledOnce
     })