@@ -8,13 +8,8 @@ Firestack handles authentication for us out of the box, both with email/password
88
99### Properties
1010
11- ##### ` authenticated: boolean `
12-
13- Returns the current Firebase authentication state.
14-
15- ##### ` currentUser: [User](#) | null `
16-
17- Returns the currently signed-in user (or null).
11+ ##### ` authenticated: boolean ` - Returns the current Firebase authentication state.
12+ ##### ` currentUser: [User](#) | null ` - Returns the currently signed-in user (or null).
1813
1914### Methods
2015
@@ -137,7 +132,7 @@ firestack.auth().signInWithCustomToken('12345')
137132
138133#### [ ` sendPasswordResetEmail(email: string): Promise ` ] ( https://firebase.google.com/docs/reference/js/firebase.auth.Auth#sendPasswordResetEmail )
139134
140- Sends a password reset email to the given email address.
135+ Sends a password reset email to the given email address. Unlike the web SDK, the email will contain a password reset link rather than a code.
141136
142137``` javascript
143138firestack .auth ().sendPasswordResetEmail (' foo@bar.com' )
@@ -149,20 +144,6 @@ firestack.auth().sendPasswordResetEmail('foo@bar.com')
149144 });
150145```
151146
152- #### [ ` confirmPasswordReset(code: string, newPassword: string): Promise ` ] ( https://firebase.google.com/docs/reference/js/firebase.auth.Auth#confirmPasswordReset )
153-
154- Completes the password reset process, given a confirmation code and new password.
155-
156- ``` javascript
157- firestack .auth ().confirmPasswordReset (' 1234' , ' barfoo4321' )
158- .then (() => {
159- console .log (' Password reset successfully' );
160- })
161- .catch ((error ) => {
162- console .error (' Unable to reset password' , error);
163- });
164- ```
165-
166147#### [ ` signOut(): Promise ` ] ( https://firebase.google.com/docs/reference/js/firebase.auth.Auth#confirmPasswordReset )
167148
168149Completes the password reset process, given a confirmation code and new password.
0 commit comments