Skip to content

Fix AuthError incoherent structure. #5600

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

Closed
wants to merge 3 commits into from
Closed
Changes from 2 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
38 changes: 20 additions & 18 deletions packages/auth/src/model/public_types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -117,26 +117,28 @@ export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;

/**
* Interface for an `Auth` error.
*
*
* @public
*/
export interface AuthError extends FirebaseError {
/** The name of the Firebase App which triggered this error. */
readonly appName: string;
/** The email of the user's account, used for sign-in/linking. */
readonly email?: string;
/** The phone number of the user's account, used for sign-in/linking. */
readonly phoneNumber?: string;
/**
* The tenant ID being used for sign-in/linking.
*
* @remarks
* If you use {@link signInWithRedirect} to sign in,
* you have to set the tenant ID on {@link Auth} instance again as the tenant ID is not persisted
* after redirection.
*/
readonly tenantid?: string;
}
export declare interface AuthError extends FirebaseError {
/** The detailed Data of the Firebase Auth error. */
readonly customData: {
/** The name of the Firebase App which triggered this error. */
readonly appName: string;
/** The email of the user's account, used for sign-in/linking. */
readonly email?: string;
/** The phone number of the user's account, used for sign-in/linking. */
readonly phoneNumber?: string;
/**
* The tenant ID being used for sign-in/linking.
*
* @remarks
* If you use {@link signInWithRedirect} to sign in,
* you have to set the tenant ID on {@link Auth} instance again as the tenant ID is not persisted
* after redirection.
*/
readonly tenantId?: string;
};}

/**
* Interface representing an {@link Auth} instance's settings.
Expand Down