Skip to content

Commit 880e0f7

Browse files
committed
changed reference doc
1 parent 330b374 commit 880e0f7

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs-devsite/auth.auth.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ export interface Auth
3737

3838
| Method | Description |
3939
| --- | --- |
40+
| [authStateReady()](./auth.auth.md#authauthstateready) | return a promise that resolves immediately when the initial auth state is settled. The current user might be a valid user, or null if there is no user signed in currently. |
4041
| [beforeAuthStateChanged(callback, onAbort)](./auth.auth.md#authbeforeauthstatechanged) | Adds a blocking callback that runs before an auth state change sets a new user. |
4142
| [onAuthStateChanged(nextOrObserver, error, completed)](./auth.auth.md#authonauthstatechanged) | Adds an observer for changes to the user's sign-in state. |
4243
| [onIdTokenChanged(nextOrObserver, error, completed)](./auth.auth.md#authonidtokenchanged) | Adds an observer for changes to the signed-in user's ID token. |
@@ -144,6 +145,19 @@ const result = await signInWithEmailAndPassword(auth, email, password);
144145

145146
```
146147

148+
## Auth.authStateReady()
149+
150+
return a promise that resolves immediately when the initial auth state is settled. The current user might be a valid user, or null if there is no user signed in currently.
151+
152+
<b>Signature:</b>
153+
154+
```typescript
155+
authStateReady(): Promise<void>;
156+
```
157+
<b>Returns:</b>
158+
159+
Promise&lt;void&gt;
160+
147161
## Auth.beforeAuthStateChanged()
148162

149163
Adds a blocking callback that runs before an auth state change sets a new user.

0 commit comments

Comments
 (0)