1.0.0 • Published 12 months ago

passcode-validator v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
12 months ago

Passcode Validator 🔐

Validate passwords and numeric codes easily using Typescript or Javascript.

Installation

For now, you can only install it using npm

npm install passcode-validator

How to use it

Create an instance from Validator class and set as many rules as you need to validate the password or PIN.

const validator = new Validator()
                        .length(8,12)
                        .upperCase()
                        .lowerCase()
                        .specialChar()
                        .build();

To validate the password or PIN call validate. The function will return you an object with the rules and the isValid boolean which tells you if the password is valid.

const { rules, isValid } = validator.validate('PassWord*');

To check what rules are completed or uncompleted call isCompleted() on every rule.

const uncompletedRules = rules.map(rule => !rule.isCompleted());

Available rules

RuleDescription
UpperCaseRequires at least an uppercase character.
No UpperCaseForbids uppercase characters.
LowerCaseRequires at least a lowercase character.
No LowerCaseForbids lowercase characters.
LengthRequires a specific length or range.
PINRequires a PIN with only digits.
DigitRequires 1 or more digits.
No DigitForbids digits.
Special CharacterRequires at least a special character.
No Special CharacterForbids special characters.
Max Repeated in rowValidates the maximum number of times any character can appear in the password consecutively.
Forbidden textForbids a text or some texts to appear in the password or PIN.

👁 More rules will be added in the near future. Open a ticket if you miss something in particular.

Support my work with a coffee!

"Buy Me A Coffee"