Skip to content

Add beforeAuthStateChanged fn export #6222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions common/api-review/auth.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,9 @@ export interface AuthSettings {
appVerificationDisabledForTesting: boolean;
}

// @public
export function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

// @public
export const browserLocalPersistence: Persistence;

Expand Down
20 changes: 20 additions & 0 deletions packages/auth/src/core/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,26 @@ export function onIdTokenChanged(
completed
);
}
/**
* Adds a blocking callback that runs before an auth state change
* sets a new user.
*
* @param auth - The {@link Auth} instance.
* @param callback - callback triggered before new user value is set.
* If this throws, it will block the user from being set.
* @param onAbort - callback triggered if a later before state changed
* callback throws, allowing you to undo any side effects.
*/
export function beforeAuthStateChanged(
auth: Auth,
callback: (user: User|null) => void | Promise<void>,
onAbort?: () => void,
): Unsubscribe {
return getModularInstance(auth).beforeAuthStateChanged(
callback,
onAbort
);
}
/**
* Adds an observer for changes to the user's sign-in state.
*
Expand Down