@augustoravazoli/password-validator NPM

password-validator

npm version npm downloads npm license

Description

A simple module to validate password with many options.

Installation

Install via NPM:

npm i @augustoravazoli/password-validator

Usage

JavaScript

const validatePassword = require("@augustoravazoli/password-validator").validate;

const options = {
  required: {
    letters: { upper: 3, lower: 2 },
    symbols: 2
  }
};

validatePassword("LSCii@#5", options); // true

TypeScript

import { validate as validatePassword } from "@augustoravazoli/password-validator";

const options = {
  required: {
    letters: { upper: 3, lower: 2 },
    symbols: 2
  }
};

validatePassword("LSCii@#5", options); // true

Reference

const options = {
  min: 8, // Minimun password length, default is 8
  max: 20, // Maximum password length, default is 20
  required: { 
    numbers: 1, // Minimun required numbers, default is 1
    letters: { 
      upper: 1, // Minimun required uppercase letters, default is 1
      lower: 1, // Minimun required lowercase letters, default is 1
      any: 0 // Minimun required any uppercase or lowercase letters, default is 0
    },
    symbols: 1 // Minimun required symbols, default is 1
  },
  prohibited: { 
    customChars: [], // Prohibited custom characters, default is empty array
    checkSequences: false, // Prohibited numbers and letters sequences like 123, default is false
    checkRepetitions: false // Prohibited numbers and letters sequences like 111, default is false
  },
  detailErrors: false // Throw deitaled errors messages, default is false
};