Back to Firebase Js Sdk

PasswordValidationStatus interface

docs-devsite/auth.passwordvalidationstatus.md

12.12.13.8 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

PasswordValidationStatus interface

A structure indicating which password policy requirements were met or violated and what the requirements are.

<b>Signature:</b>

typescript
export interface PasswordValidationStatus 

Properties

PropertyTypeDescription
containsLowercaseLetterbooleanWhether the password contains a lowercase letter, or undefined if not required.
containsNonAlphanumericCharacterbooleanWhether the password contains a non-alphanumeric character, or undefined if not required.
containsNumericCharacterbooleanWhether the password contains a numeric character, or undefined if not required.
containsUppercaseLetterbooleanWhether the password contains an uppercase letter, or undefined if not required.
isValidbooleanWhether the password meets all requirements.
meetsMaxPasswordLengthbooleanWhether the password meets the maximum password length, or undefined if not required.
meetsMinPasswordLengthbooleanWhether the password meets the minimum password length, or undefined if not required.
passwordPolicyPasswordPolicyThe policy used to validate the password.

PasswordValidationStatus.containsLowercaseLetter

Whether the password contains a lowercase letter, or undefined if not required.

<b>Signature:</b>

typescript
readonly containsLowercaseLetter?: boolean;

PasswordValidationStatus.containsNonAlphanumericCharacter

Whether the password contains a non-alphanumeric character, or undefined if not required.

<b>Signature:</b>

typescript
readonly containsNonAlphanumericCharacter?: boolean;

PasswordValidationStatus.containsNumericCharacter

Whether the password contains a numeric character, or undefined if not required.

<b>Signature:</b>

typescript
readonly containsNumericCharacter?: boolean;

PasswordValidationStatus.containsUppercaseLetter

Whether the password contains an uppercase letter, or undefined if not required.

<b>Signature:</b>

typescript
readonly containsUppercaseLetter?: boolean;

PasswordValidationStatus.isValid

Whether the password meets all requirements.

<b>Signature:</b>

typescript
readonly isValid: boolean;

PasswordValidationStatus.meetsMaxPasswordLength

Whether the password meets the maximum password length, or undefined if not required.

<b>Signature:</b>

typescript
readonly meetsMaxPasswordLength?: boolean;

PasswordValidationStatus.meetsMinPasswordLength

Whether the password meets the minimum password length, or undefined if not required.

<b>Signature:</b>

typescript
readonly meetsMinPasswordLength?: boolean;

PasswordValidationStatus.passwordPolicy

The policy used to validate the password.

<b>Signature:</b>

typescript
readonly passwordPolicy: PasswordPolicy;