mirror of
https://github.com/sigmasternchen/jsPasswordChecker
synced 2025-03-16 00:08:55 +00:00
Update README.md
This commit is contained in:
parent
c76902890b
commit
b5721f9b63
1 changed files with 40 additions and 0 deletions
40
README.md
40
README.md
|
@ -10,6 +10,7 @@ var checker = new PasswordChecker({
|
|||
});
|
||||
checker.check(password);
|
||||
```
|
||||
If the given criteria are not met, any exception is thrown.
|
||||
|
||||
Simple as that.
|
||||
|
||||
|
@ -18,11 +19,50 @@ Simple as that.
|
|||
In the current version the following criteria can be set:
|
||||
|
||||
- minLength
|
||||
- Value: Integer
|
||||
- Specifies the minimal length of the password.
|
||||
- maxLength
|
||||
- Value: Integer
|
||||
- Specifies the maximal length of the password (Please don't.)
|
||||
- containsNumbers
|
||||
- Value: Boolean/Integer
|
||||
- If the value is `false` the password must not contain any numbers. if the value is an integer, the password has to contain at least the given number of digits. A value of `true` is identical to `1`.
|
||||
- containsLowerCaseCharacters
|
||||
- Value: Boolean/Integer
|
||||
- If the value is `false` the password must not contain any lowercase characters. if the value is an integer, the password has to contain at least the given number of lowercase characters. A value of `true` is identical to `1`.
|
||||
- containsUpperCaseCharacters
|
||||
- Value: Boolean/Integer
|
||||
- If the value is `false` the password must not contain any uppercase characters. if the value is an integer, the password has to contain at least the given number of uppercase characters. A value of `true` is identical to `1`.
|
||||
- containsWhiteSpaces
|
||||
- Value: Boolean/Integer
|
||||
- If the value is `false` the password must not contain any whitespaces. if the value is an integer, the password has to contain at least the given number of whitespaces. A value of `true` is identical to `1`.
|
||||
- containsSpecialCharacters
|
||||
- Value: Boolean/Integer
|
||||
- If the value is `false` the password must not contain any special characters. if the value is an integer, the password has to contain at least the given number of special characters. A value of `true` is identical to `1`.
|
||||
- dictionary
|
||||
- Value: Array of strings
|
||||
- The password must not contain any of the given strings (case-insensitive).
|
||||
- maxCharacterRepetition
|
||||
- Value: Integer
|
||||
- Specifies the maximal number of consecutive identical characters.
|
||||
|
||||
# Example
|
||||
|
||||
```javascript
|
||||
var checker = new PasswordChecker({
|
||||
minLength: 10,
|
||||
containsUpperCaseCharacters: true,
|
||||
containsLowerCaseCharacters: true,
|
||||
containsNumbers: 2,
|
||||
containsWhiteSpaces: false,
|
||||
dictionary: [
|
||||
"username",
|
||||
"dayofbirth"
|
||||
]
|
||||
});
|
||||
|
||||
checker.check("VeryStrongP4ssword"); // will fail because there is only 1 number in the password
|
||||
checker.check("Very Str0ng P4ssword"); // will fail because there are whitespaces in the password
|
||||
checker.check("VeryStr0ngP4ssword"); // won't fail; all criteria satisfied
|
||||
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue