Changeset for beforeAuthStateChanged() (#6221)

hsubox76 · web-flow · commit 00c55a37d767 · 2022-05-05T09:27:41.000-07:00
diff --git a/.changeset/light-poets-eat.md b/.changeset/light-poets-eat.md
@@ -0,0 +1,7 @@
+---
+'@firebase/auth': minor
+'@firebase/auth-compat': patch
+---
+
+Add `beforeAuthStateChanged()` middleware function which allows the user to provide callbacks that are run before an auth state change
+sets a new user.
diff --git a/packages/auth/src/model/public_types.ts b/packages/auth/src/model/public_types.ts
@@ -259,7 +259,7 @@ export interface Auth {
    * sets a new user.
    *
    * @param callback - callback triggered before new user value is set.
-   *   If this throws, it will block the user from being set.
+   *   If this throws, it blocks the user from being set.
    */
   beforeAuthStateChanged(
     callback: (user: User | null) => void | Promise<void>

Original file line number	Diff line number	Diff line change
`@@ -259,7 +259,7 @@ export interface Auth {`
`259`	`259`	`* sets a new user.`
`260`	`260`	`*`
`261`	`261`	`* @param callback - callback triggered before new user value is set.`
`262`		`- * If this throws, it will block the user from being set.`
	`262`	`+ * If this throws, it blocks the user from being set.`
`263`	`263`	`*/`
`264`	`264`	`beforeAuthStateChanged(`
`265`	`265`	`callback: (user: User \| null) => void \| Promise<void>`