Skip to content
This repository was archived by the owner on Mar 17, 2025. It is now read-only.

Commit 9fec5c0

Browse files
author
jwngr
committed
Updated docs for $firebaseAuth.$signOut()
1 parent 3742de5 commit 9fec5c0

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/migration/1XX-to-2XX.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Several authentication methods have been renamed and / or have different method
5252
| `$changeEmail(credentials)` | `$updateEmail(newEmail)` | Changes the email of the currently signed-in user |
5353
| `$changePassword(credentials)` | `$updatePassword(newPassword)` | Changes the password of the currently signed-in user |
5454
| `$resetPassword(credentials)` | `$sendPasswordResetEmail(email)` | |
55-
| `$unauth()` | `$signOut()` | |
55+
| `$unauth()` | `$signOut()` | Now returns a `Promise`|
5656
| `$onAuth(callback)` | `$onAuthStateChanged(callback)` | |
5757
| `$requireAuth()` | `$requireSignIn()` | |
5858
| `$waitForAuth()` | `$waitForSignIn()` | |

docs/reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -752,8 +752,8 @@ offAuth();
752752

753753
### $signOut()
754754

755-
Unauthenticates a client from the Firebase Database. It takes no arguments and returns no value.
756-
When called, the `$onAuthStateChanged()` callback(s) will be triggered.
755+
Signs out a client. It takes no arguments and returns a `Promise` when the client has been signed
756+
out. Upon fulfillment, the `$onAuthStateChanged()` callback(s) will be triggered.
757757

758758
```html
759759
<span ng-show="firebaseUser">

0 commit comments

Comments
 (0)