@aws-amplify/auth 5.5.6-v5-user-agent-for-ui.03d3911.15 → 5.6.1-github-actions.c2933e1.0

package/lib/Auth.d.ts

@@ -64,7 +64,7 @@ export declare class AuthClass {
     signIn(usernameOrSignInOpts: string | SignInOpts, pw?: string, clientMetadata?: ClientMetaData): Promise<CognitoUser | any>;
     /**
      * Return an object with the authentication callbacks
-     * @param {InternalCognitoUser} user - the cognito user object
+     * @param {CognitoUser} user - the cognito user object
      * @param {} resolve - function called when resolving the current step
      * @param {} reject - function called when rejecting the current step
      * @return - an object with the callback methods for user authentication
@@ -74,14 +74,14 @@ export declare class AuthClass {
      * Sign in with a password
      * @private
      * @param {AuthenticationDetails} authDetails - the user sign in data
-     * @return - A promise resolves the InternalCognitoUser object if success or mfa required
+     * @return - A promise resolves the CognitoUser object if success or mfa required
      */
     private signInWithPassword;
     /**
      * Sign in without a password
      * @private
      * @param {AuthenticationDetails} authDetails - the user sign in data
-     * @return - A promise resolves the InternalCognitoUser object if success or mfa required
+     * @return - A promise resolves the CognitoUser object if success or mfa required
      */
     private signInWithoutPassword;
     /**
@@ -137,20 +137,20 @@ export declare class AuthClass {
     verifyTotpToken(user: CognitoUser | any, challengeAnswer: string): Promise<CognitoUserSession>;
     /**
      * Send MFA code to confirm sign in
-     * @param {CognitoUser} user - The CognitoUser object
-     * @param {string} code - The confirmation code
+     * @param {Object} user - The CognitoUser object
+     * @param {String} code - The confirmation code
      */
     confirmSignIn(user: CognitoUser | any, code: string, mfaType?: 'SMS_MFA' | 'SOFTWARE_TOKEN_MFA' | null, clientMetadata?: ClientMetaData): Promise<CognitoUser | any>;
     completeNewPassword(user: CognitoUser | any, password: string, requiredAttributes?: any, clientMetadata?: ClientMetaData): Promise<CognitoUser | any>;
     /**
      * Send the answer to a custom challenge
-     * @param {CognitoUser} user - The InternalCognitoUser object
+     * @param {CognitoUser} user - The CognitoUser object
      * @param {String} challengeResponses - The confirmation code
      */
     sendCustomChallengeAnswer(user: CognitoUser | any, challengeResponses: string, clientMetadata?: ClientMetaData): Promise<CognitoUser | any>;
     /**
      * Delete an authenticated users' attributes
-     * @param {CognitoUser} user - The currently logged in user object
+     * @param {CognitoUser} - The currently logged in user object
      * @return {Promise}
      **/
     deleteUserAttributes(user: CognitoUser | any, attributeNames: string[]): Promise<unknown>;
@@ -161,14 +161,14 @@ export declare class AuthClass {
     deleteUser(): Promise<string | void>;
     /**
      * Update an authenticated users' attributes
-     * @param {CognitoUser} user - The currently logged in user object
+     * @param {CognitoUser} - The currently logged in user object
      * @return {Promise}
      **/
     updateUserAttributes(user: CognitoUser | any, attributes: object, clientMetadata?: ClientMetaData): Promise<string>;
     private createUpdateAttributesResultList;
     /**
      * Return user attributes
-     * @param {Object} user - The InternalCognitoUser object
+     * @param {Object} user - The CognitoUser object
      * @return - A promise resolves to user attributes if success
      */
     userAttributes(user: CognitoUser | any): Promise<CognitoUserAttribute[]>;