Skip to main content

Interface: AuthError

Represents an authentication error payload returned during authentication operations. This structure provides detailed information about authentication failures.

Example​

// Handling authentication errors
window.mimeeqAuth.authorization.signIn(email, password, customerId)
  .then(result => {
    if ('name' in result) {
      // This is an error
      console.error(`Authentication error: ${result.message}`);
      if (result.name === AuthErrorTypes.UserNotConfirmedException) {
        // Handle unconfirmed user case
      }
    } else {
      // Successful login
    }
  });

Properties​

message​

message: string

A descriptive message explaining the authentication error. This provides user-friendly information about what went wrong.

name​

name: AuthErrorTypes | "NO_EMAIL"

The error code identifying the specific type of authentication error. This can be used for programmatic error handling.