AngularFireAuth API's #555
Conversation
Added AngulaFireAuth API's as per issue #93. Please review and let me know, if any changes are needed.
| @mukesh51 fixing typo (copied from another CL) and adding this change to make this consistent with the auth guide. |
docs/api-reference.md Outdated
| .... | ||
| ``` | ||
| | ||
| This is similar to how firebase provides authentication |
There was a problem hiding this comment.
Please revise these to just say: See [link] for more and place these up in the description instead of below the usage example.
There was a problem hiding this comment.
@katowulf Updated as advised.
docs/api-reference.md Outdated
| The credentials object is an object containing email and password of the user to be created. Similar to [createUserWithEmailAndPassword](https://firebase.google.com/docs/reference/js/firebase.auth.Auth#createUserWithEmailAndPassword) | ||
| ```ts | ||
| createNewUser(): Promise<FirebaseAuthState> { |
There was a problem hiding this comment.
I think this should be: createNewUser( properties:Object ): Promise<FirebaseAuthState> {?
There was a problem hiding this comment.
@katowulf Updated as advised. yes it's a
createNewUser( properties:Object ): Promise
docs/api-reference.md Outdated
| } | ||
| ``` | ||
| `logout(): void`: Deletes the authentication token issued by Firebase and signs user out. See [Auth.signOut()](https://firebase.google.com/docs/reference/js/firebase.auth.Auth#signOut) in the Firebase API reference. |
There was a problem hiding this comment.
Probably worth noting that logout() is an asynchronous operation. There is an open bug against the Firebase SDK to make this return a promise.
There was a problem hiding this comment.
@katowulf Thanks for update. I was unaware that this is an open bug against firebase. I pasted the contents as per your suggestion. Hope that's ok.
docs/api-reference.md Outdated
| ``` | ||
| `getAuth(): FirebaseAuthState` : Returns the client's current Authentication State. |
There was a problem hiding this comment.
Where is FirebaseAuthState documented? Can we link to it?
There was a problem hiding this comment.
FirebaseAuthState is an interface in the definition file auth_backend.d.ts. I added the method signature in documentation, which might be helpful, incase someone is digging for more information.
I think it is similar to https://firebase.google.com/docs/reference/js/firebase.auth.AuthCredential , but I am not sure, hence didn't link it. Please verify and let me know as well. Thanks.,
| Hi @mukesh51! Great work! I added a few comments. Please address. |
Updated API's based on the comments received.
| Hi @katowulf . Did you get a chance to review this. Anything missing ?? |
| Great work! Sorry it took a while to get these reviewed. |
3 participants
Added AngulaFireAuth API's as per issue #93. Please review and let me know, if any changes are needed.