Update onIdTokenChanged docs about token expiration. (#7054)

prameshj · web-flow · commit 81cb20a2fb41 · 2023-03-29T15:53:22.000-07:00
diff --git a/docs-devsite/auth.md b/docs-devsite/auth.md
@@ -536,7 +536,7 @@ export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObs
 
 Adds an observer for changes to the signed-in user's ID token.
 
-This includes sign-in, sign-out, and token refresh events.
+This includes sign-in, sign-out, and token refresh events. This will not be triggered automatically upon ID token expiration. Use [User.getIdToken()](./auth.user.md#usergetidtoken) to refresh the ID token.
 
 <b>Signature:</b>
 
diff --git a/packages/auth/src/core/index.ts b/packages/auth/src/core/index.ts
@@ -65,6 +65,7 @@ export function setPersistence(
  *
  * @remarks
  * This includes sign-in, sign-out, and token refresh events.
+ * This will not be triggered automatically upon ID token expiration. Use {@link User.getIdToken} to refresh the ID token.
  *
  * @param auth - The {@link Auth} instance.
  * @param nextOrObserver - callback triggered on change.

Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,7 @@ export function setPersistence(`
`65`	`65`	`*`
`66`	`66`	`* @remarks`
`67`	`67`	`* This includes sign-in, sign-out, and token refresh events.`
	`68`	`+ * This will not be triggered automatically upon ID token expiration. Use {@link User.getIdToken} to refresh the ID token.`
`68`	`69`	`*`
`69`	`70`	`* @param auth - The {@link Auth} instance.`
`70`	`71`	`* @param nextOrObserver - callback triggered on change.`