|
| 1 | +Project: /docs/reference/js/_project.yaml |
| 2 | +Book: /docs/reference/_book.yaml |
| 3 | +page_type: reference |
| 4 | + |
| 5 | +{% comment %} |
| 6 | +DO NOT EDIT THIS FILE! |
| 7 | +This is generated by the JS SDK team, and any local changes will be |
| 8 | +overwritten. Changes should be made in the source code at |
| 9 | +https://github.com/firebase/firebase-js-sdk |
| 10 | +{% endcomment %} |
| 11 | + |
| 12 | +# PasswordValidationStatus interface |
| 13 | +A structure indicating which password policy requirements were met or violated and what the requirements are. |
| 14 | + |
| 15 | +<b>Signature:</b> |
| 16 | + |
| 17 | +```typescript |
| 18 | +export interface PasswordValidationStatus |
| 19 | +``` |
| 20 | + |
| 21 | +## Properties |
| 22 | + |
| 23 | +| Property | Type | Description | |
| 24 | +| --- | --- | --- | |
| 25 | +| [containsLowercaseLetter](./auth.passwordvalidationstatus.md#passwordvalidationstatuscontainslowercaseletter) | boolean | Whether the password contains a lowercase letter, or undefined if not required. | |
| 26 | +| [containsNonAlphanumericCharacter](./auth.passwordvalidationstatus.md#passwordvalidationstatuscontainsnonalphanumericcharacter) | boolean | Whether the password contains a non-alphanumeric character, or undefined if not required. | |
| 27 | +| [containsNumericCharacter](./auth.passwordvalidationstatus.md#passwordvalidationstatuscontainsnumericcharacter) | boolean | Whether the password contains a numeric character, or undefined if not required. | |
| 28 | +| [containsUppercaseLetter](./auth.passwordvalidationstatus.md#passwordvalidationstatuscontainsuppercaseletter) | boolean | Whether the password contains an uppercase letter, or undefined if not required. | |
| 29 | +| [isValid](./auth.passwordvalidationstatus.md#passwordvalidationstatusisvalid) | boolean | Whether the password meets all requirements. | |
| 30 | +| [meetsMaxPasswordLength](./auth.passwordvalidationstatus.md#passwordvalidationstatusmeetsmaxpasswordlength) | boolean | Whether the password meets the maximum password length, or undefined if not required. | |
| 31 | +| [meetsMinPasswordLength](./auth.passwordvalidationstatus.md#passwordvalidationstatusmeetsminpasswordlength) | boolean | Whether the password meets the minimum password length, or undefined if not required. | |
| 32 | +| [passwordPolicy](./auth.passwordvalidationstatus.md#passwordvalidationstatuspasswordpolicy) | [PasswordPolicy](./auth.passwordpolicy.md#passwordpolicy_interface) | The policy used to validate the password. | |
| 33 | + |
| 34 | +## PasswordValidationStatus.containsLowercaseLetter |
| 35 | + |
| 36 | +Whether the password contains a lowercase letter, or undefined if not required. |
| 37 | + |
| 38 | +<b>Signature:</b> |
| 39 | + |
| 40 | +```typescript |
| 41 | +readonly containsLowercaseLetter?: boolean; |
| 42 | +``` |
| 43 | + |
| 44 | +## PasswordValidationStatus.containsNonAlphanumericCharacter |
| 45 | + |
| 46 | +Whether the password contains a non-alphanumeric character, or undefined if not required. |
| 47 | + |
| 48 | +<b>Signature:</b> |
| 49 | + |
| 50 | +```typescript |
| 51 | +readonly containsNonAlphanumericCharacter?: boolean; |
| 52 | +``` |
| 53 | + |
| 54 | +## PasswordValidationStatus.containsNumericCharacter |
| 55 | + |
| 56 | +Whether the password contains a numeric character, or undefined if not required. |
| 57 | + |
| 58 | +<b>Signature:</b> |
| 59 | + |
| 60 | +```typescript |
| 61 | +readonly containsNumericCharacter?: boolean; |
| 62 | +``` |
| 63 | + |
| 64 | +## PasswordValidationStatus.containsUppercaseLetter |
| 65 | + |
| 66 | +Whether the password contains an uppercase letter, or undefined if not required. |
| 67 | + |
| 68 | +<b>Signature:</b> |
| 69 | + |
| 70 | +```typescript |
| 71 | +readonly containsUppercaseLetter?: boolean; |
| 72 | +``` |
| 73 | + |
| 74 | +## PasswordValidationStatus.isValid |
| 75 | + |
| 76 | +Whether the password meets all requirements. |
| 77 | + |
| 78 | +<b>Signature:</b> |
| 79 | + |
| 80 | +```typescript |
| 81 | +readonly isValid: boolean; |
| 82 | +``` |
| 83 | + |
| 84 | +## PasswordValidationStatus.meetsMaxPasswordLength |
| 85 | + |
| 86 | +Whether the password meets the maximum password length, or undefined if not required. |
| 87 | + |
| 88 | +<b>Signature:</b> |
| 89 | + |
| 90 | +```typescript |
| 91 | +readonly meetsMaxPasswordLength?: boolean; |
| 92 | +``` |
| 93 | + |
| 94 | +## PasswordValidationStatus.meetsMinPasswordLength |
| 95 | + |
| 96 | +Whether the password meets the minimum password length, or undefined if not required. |
| 97 | + |
| 98 | +<b>Signature:</b> |
| 99 | + |
| 100 | +```typescript |
| 101 | +readonly meetsMinPasswordLength?: boolean; |
| 102 | +``` |
| 103 | + |
| 104 | +## PasswordValidationStatus.passwordPolicy |
| 105 | + |
| 106 | +The policy used to validate the password. |
| 107 | + |
| 108 | +<b>Signature:</b> |
| 109 | + |
| 110 | +```typescript |
| 111 | +readonly passwordPolicy: PasswordPolicy; |
| 112 | +``` |
0 commit comments