Skip to content

Commit 821920f

Browse files
Apply suggestions from code review
Co-authored-by: Kevin Cheung <[email protected]>
1 parent 4ef325a commit 821920f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

packages/auth/src/model/public_types.ts

+7-7
Original file line numberDiff line numberDiff line change
@@ -121,20 +121,20 @@ export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
121121
* @public
122122
*/
123123
export interface AuthError extends FirebaseError {
124-
/** The detailed Data of the Firebase Auth error. */
124+
/** Details about the Firebase Auth error. */
125125
readonly customData: {
126126
/** The name of the Firebase App which triggered this error. */
127127
readonly appName: string;
128-
/** The email of the user's account, used for sign-in/linking. */
128+
/** The email address of the user's account, used for sign-in and linking. */
129129
readonly email?: string;
130-
/** The phone number of the user's account, used for sign-in/linking. */
130+
/** The phone number of the user's account, used for sign-in and linking. */
131131
readonly phoneNumber?: string;
132132
/**
133-
* The tenant ID being used for sign-in/linking.
133+
* The tenant ID being used for sign-in and linking.
134134
*
135135
* @remarks
136136
* If you use {@link signInWithRedirect} to sign in,
137-
* you have to set the tenant ID on {@link Auth} instance again as the tenant ID is not persisted
137+
* you have to set the tenant ID on the {@link Auth} instance again as the tenant ID is not persisted
138138
* after redirection.
139139
*/
140140
readonly tenantId?: string;
@@ -603,10 +603,10 @@ export interface MultiFactorAssertion {
603603
* @public
604604
*/
605605
export interface MultiFactorError extends AuthError {
606-
/** The detailed Data of the MultiFactorError. */
606+
/** Details about the MultiFactorError. */
607607
readonly customData: AuthError['customData'] & {
608608
/**
609-
* The type of operation (e.g., sign-in, link, or reauthenticate) during which the error was raised.
609+
* The type of operation (sign-in, linking, or re-authentication) that raised the error.
610610
*/
611611
readonly operationType: typeof OperationTypeMap[keyof typeof OperationTypeMap];
612612
}

0 commit comments

Comments
 (0)