validator vs zxcvbn vs password-validator
Password Validation Strategies for Web Applications
validatorzxcvbnpassword-validatorSimilar Packages:

Password Validation Strategies for Web Applications

password-validator, validator, and zxcvbn are JavaScript libraries used to validate user passwords, but they serve different security goals. password-validator focuses on enforcing specific policy rules like length and character types using a chainable schema. validator is a general-purpose string validation library that includes a specific method for strong password checks alongside email and URL validation. zxcvbn estimates password strength based on entropy and pattern matching rather than enforcing rigid rules, helping users avoid common weak passwords.

Npm Package Weekly Downloads Trend

3 Years

Github Stars Ranking

Stat Detail

Package
Downloads
Stars
Size
Issues
Publish
License
validator25,623,04423,739824 kB4865 months agoMIT
zxcvbn1,565,36816,034-14510 years agoMIT
password-validator134,44228235.8 kB7-MIT

Password Validation Strategies: Policy vs. Entropy vs. General Utility

Choosing the right password validation library depends on whether you need to enforce rules, estimate strength, or generalize form validation. password-validator, validator, and zxcvbn each solve this problem with different underlying logic. Let's compare how they handle common security requirements.

🛡️ Core Logic: Rules vs. Patterns vs. Utilities

password-validator enforces explicit schema rules.

  • You define exactly what is allowed (length, uppercase, symbols).
  • It returns true or false based on strict compliance.
// password-validator: Define strict rules
const schema = new PasswordValidator();
schema
  .is().min(8)
  .is().max(100)
  .has().uppercase()
  .has().lowercase()
  .has().digits();

const isValid = schema.validate('SecurePass1');

validator provides a general string check function.

  • It uses internal regex and logic to determine strength.
  • Best used alongside other string validations like email checks.
// validator: General strength check
import validator from 'validator';

const isValid = validator.isStrongPassword('SecurePass1', {
  minLength: 8,
  minLowercase: 1,
  minUppercase: 1,
  minNumbers: 1,
  minSymbols: 1
});

zxcvbn estimates entropy and crack time.

  • It does not enforce rules but scores password quality.
  • Detects patterns like "password123" or dictionary words.
// zxcvbn: Strength estimation
import zxcvbn from 'zxcvbn';

const result = zxcvbn('SecurePass1');
// result.score is 0 (weak) to 4 (strong)
const isStrong = result.score >= 3;

⚙️ Configuration & Flexibility

password-validator uses a chainable interface for rules.

  • Easy to read and modify specific constraints.
  • You can invert rules (e.g., .not().digits()).
// password-validator: Flexible chaining
const schema = new PasswordValidator();
schema
  .is().min(10)
  .not().spaces()
  .has().symbols(2); // Requires at least 2 symbols

validator uses an options object for configuration.

  • All settings are passed at once during the function call.
  • Less readable for complex policies but concise for simple checks.
// validator: Options object
const isValid = validator.isStrongPassword('Pass123!', {
  minLength: 8,
  minSymbols: 1
});

zxcvbn requires no configuration for basic use.

  • It works out of the box with built-in dictionaries.
  • You can add custom dictionaries for domain-specific terms.
// zxcvbn: Custom dictionaries
const result = zxcvbn('password', ['companyName', 'projectCode']);
// Lowers score if password contains custom terms

📝 Error Feedback & User Guidance

password-validator can return detailed failure reasons.

  • Use .validate(string, { list: true }) to get failed rules.
  • Helps users fix specific policy violations.
// password-validator: Detailed errors
const errors = schema.validate('short', { list: true });
// Returns: ['min', 'uppercase', 'digits', ...]

validator returns a boolean only.

  • You must implement your own error messaging logic.
  • Less helpful for guiding users on why validation failed.
// validator: Boolean result only
const isValid = validator.isStrongPassword('short');
// false - You must guess why it failed

zxcvbn provides rich feedback data.

  • Returns warnings and suggestions based on patterns.
  • Excellent for real-time strength meters.
// zxcvbn: Warnings and suggestions
const result = zxcvbn('password123');
console.log(result.feedback.warning); // "This is a top-10 common password"
console.log(result.feedback.suggestions); // ["Add another word..."]

🔒 Security Reality: Client-Side Limitations

All three libraries run on the client side, which has security implications.

  • Never rely solely on client-side validation for security.
  • Attackers can bypass JavaScript checks entirely.
  • Always re-validate passwords on the server using the same logic.
// All packages: Server-side repetition required
// Frontend
const isValid = schema.validate(password);
if (!isValid) return;

// Backend (Node.js)
// Must repeat the same validation logic here
const serverValid = schema.validate(password);

🤝 Similarities: Shared Ground Between Libraries

While their approaches differ, these libraries share core characteristics and use cases.

1. 🟢 Pure JavaScript Logic

  • All run in Node.js and modern browsers without heavy dependencies.
  • No network calls are made during validation.
// Example: All work offline
// password-validator
const v1 = new PasswordValidator().validate('test');
// validator
const v2 = validator.isStrongPassword('test');
// zxcvbn
const v3 = zxcvbn('test').score;

2. 🔢 Synchronous Execution

  • All validation happens synchronously.
  • No need for await or promises during checks.
// Example: Sync usage in all three
function check(pwd) {
  const a = schema.validate(pwd);
  const b = validator.isStrongPassword(pwd);
  const c = zxcvbn(pwd).score;
  return { a, b, c };
}

3. 🛠️ Customization Support

  • Each allows some level of tuning to fit project needs.
  • Whether via schema, options, or dictionaries.
// Example: Tuning thresholds
// password-validator
schema.is().min(12);
// validator
validator.isStrongPassword(pwd, { minLength: 12 });
// zxcvbn
// Logic based on result.score >= 3

4. ✅ Open Source & Community Tested

  • All are widely adopted in the JavaScript ecosystem.
  • Regularly updated to handle new security patterns.
// Example: Import patterns
import PasswordValidator from 'password-validator';
import validator from 'validator';
import zxcvbn from 'zxcvbn';

5. 📉 Lightweight Footprint

  • Designed to be included in frontend bundles without bloating.
  • Focus on single-purpose functionality.
// Example: Tree-shaking friendly
// All packages export main functions cleanly
// No heavy UI components or runtime overhead

📊 Summary: Key Similarities

FeatureShared by All Three
Environment🟢 Node.js & Browser
Execution🔢 Synchronous
Security🔒 Client-side only (verify backend)
Dependencies📉 Minimal
License✅ Open Source

🆚 Summary: Key Differences

Featurepassword-validatorvalidatorzxcvbn
Primary Goal📋 Enforce Policy Rules🧰 General String Validation📈 Estimate Strength & Entropy
API Style🔗 Chainable Schema📦 Options Object🎯 Function Call
Feedback📝 List of Failed Rules❌ Boolean Only💡 Warnings & Suggestions
Logic🛑 Regex & Composition🛑 Regex & Composition🧠 Pattern Matching & Entropy
Best ForCompliance & Strict PoliciesExisting Validator UsersUX & Strength Meters

💡 The Big Picture

password-validator is like a security guard with a checklist 📋 — it ensures every specific requirement is met before granting access. Ideal for enterprise apps, compliance-heavy forms, and systems requiring strict composition rules.

validator is like a Swiss Army knife 🔪 — it handles password strength as one of many string tasks. Perfect for projects already using it for emails and URLs where adding a single dependency for passwords feels unnecessary.

zxcvbn is like a security consultant 🕵️ — it analyzes how hard the password is to crack rather than just checking boxes. Best for consumer apps where guiding users to better habits matters more than enforcing symbols.

Final Thought: For maximum security, combine zxcvbn for user feedback with password-validator or validator for minimum policy enforcement. Always remember to repeat these checks on your server — client-side validation is for UX, not security.

How to Choose: validator vs zxcvbn vs password-validator

  • validator:

    Choose validator if you already use it for general form validation like emails, URLs, or phone numbers. It reduces dependencies by handling strong password checks within a broader utility library. This is suitable for projects where minimizing package count is a priority and you need standard strength checks.

  • zxcvbn:

    Choose zxcvbn if you want to guide users toward stronger passwords without enforcing rigid composition rules. It is best for user-facing feedback that explains why a password is weak based on real-world cracking patterns. Use this when user experience and actual security entropy matter more than checkbox compliance.

  • password-validator:

    Choose password-validator if you need to enforce specific corporate or compliance policies regarding password composition. It is ideal when you must guarantee that passwords contain symbols, numbers, or specific lengths before submission. The chainable API makes it easy to read and modify rules as requirements change.

README for validator

validator.js

NPM version CI Coverage Downloads Backers on Open Collective Sponsors on Open Collective License Gitter

A library of string validators and sanitizers.

Strings only

This library validates and sanitizes strings only.

If you're not sure if your input is a string, coerce it using input + ''. Passing anything other than a string will result in an error.

Installation and Usage

Server-side usage

Install the validator package as:

npm i validator
yarn add validator
pnpm i validator

No ES6

var validator = require('validator');

validator.isEmail('foo@bar.com'); //=> true

ES6

import validator from 'validator';

Or, import only a subset of the library:

import isEmail from 'validator/lib/isEmail';

Tree-shakeable ES imports

import isEmail from 'validator/es/lib/isEmail';

Client-side usage

The library can be loaded either as a standalone script, or through an AMD-compatible loader

<script type="text/javascript" src="validator.min.js"></script>
<script type="text/javascript">
  validator.isEmail('foo@bar.com'); //=> true
</script>

The library can also be installed through bower

$ bower install validator-js

CDN

<script src="https://unpkg.com/validator@latest/validator.min.js"></script>

Validators

Here is a list of the validators currently available.

ValidatorDescription
contains(str, seed [, options])check if the string contains the seed.

options is an object that defaults to { ignoreCase: false, minOccurrences: 1 }.
Options:
ignoreCase: Ignore case when doing comparison, default false.
minOccurrences: Minimum number of occurrences for the seed in the string. Defaults to 1.
equals(str, comparison)check if the string matches the comparison.
isAbaRouting(str)check if the string is an ABA routing number for US bank account / cheque.
isAfter(str [, options])check if the string is a date that is after the specified date.

options is an object that defaults to { comparisonDate: Date().toString() }.
Options:
comparisonDate: Date to compare to. Defaults to Date().toString() (now).
isAlpha(str [, locale, options])check if the string contains only letters (a-zA-Z).

locale is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'bn', 'bn-IN', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'eo', 'es-ES', 'fa-IR', 'fi-FI', 'fr-CA', 'fr-FR', 'gu-IN', 'he', 'hi-IN', 'hu-HU', 'it-IT', 'ja-JP', 'kk-KZ', 'kn-IN', 'ko-KR', 'ku-IQ', 'ml-IN', 'nb-NO', 'nl-NL', 'nn-NO', 'or-IN', 'pa-IN', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'si-LK', 'sk-SK', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'ta-IN', 'te-IN', 'th-TH', 'tr-TR', 'uk-UA'] and defaults to en-US. Locale list is validator.isAlphaLocales. options is an optional object that can be supplied with the following key(s): ignore which can either be a String or RegExp of characters to be ignored e.g. " -" will ignore spaces and -'s.
isAlphanumeric(str [, locale, options])check if the string contains only letters and numbers (a-zA-Z0-9).

locale is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'bn', 'bn-IN', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'eo', 'es-ES', 'fa-IR', 'fi-FI', 'fr-CA', 'fr-FR', 'gu-IN', 'he', 'hi-IN', 'hu-HU', 'it-IT', 'ja-JP', 'kk-KZ', 'kn-IN', 'ko-KR', 'ku-IQ', 'ml-IN', 'nb-NO', 'nl-NL', 'nn-NO', 'or-IN', 'pa-IN', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'si-LK', 'sk-SK', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'ta-IN', 'te-IN', 'th-TH', 'tr-TR', 'uk-UA']) and defaults to en-US. Locale list is validator.isAlphanumericLocales. options is an optional object that can be supplied with the following key(s): ignore which can either be a String or RegExp of characters to be ignored e.g. " -" will ignore spaces and -'s.
isAscii(str)check if the string contains ASCII chars only.
isBase32(str [, options])check if the string is base32 encoded. options is optional and defaults to { crockford: false }.
When crockford is true it tests the given base32 encoded string using Crockford's base32 alternative.
isBase58(str)check if the string is base58 encoded.
isBase64(str [, options])check if the string is base64 encoded. options is optional and defaults to { urlSafe: false, padding: true }
when urlSafe is true default value for padding is false and it tests the given base64 encoded string is url safe.
isBefore(str [, options])check if the string is a date that is before the specified date.

options is an object that defaults to { comparisonDate: Date().toString() }.

Options:
comparisonDate: Date to compare to. Defaults to Date().toString() (now).
isBIC(str)check if the string is a BIC (Bank Identification Code) or SWIFT code.
isBoolean(str [, options])check if the string is a boolean.
options is an object which defaults to { loose: false }. If loose is set to false, the validator will strictly match ['true', 'false', '0', '1']. If loose is set to true, the validator will also match 'yes', 'no', and will match a valid boolean string of any case. (e.g.: ['true', 'True', 'TRUE']).
isBtcAddress(str)check if the string is a valid BTC address.
isByteLength(str [, options])check if the string's length (in UTF-8 bytes) falls in a range.

options is an object which defaults to { min: 0, max: undefined }.
isCreditCard(str [, options])check if the string is a credit card number.

options is an optional object that can be supplied with the following key(s): provider is an optional key whose value should be a string, and defines the company issuing the credit card. Valid values include ['amex', 'dinersclub', 'discover', 'jcb', 'mastercard', 'unionpay', 'visa'] or blank will check for any provider.
isCurrency(str [, options])check if the string is a valid currency amount.

options is an object which defaults to { symbol: '$', require_symbol: false, allow_space_after_symbol: false, symbol_after_digits: false, allow_negatives: true, parens_for_negatives: false, negative_sign_before_digits: false, negative_sign_after_digits: false, allow_negative_sign_placeholder: false, thousands_separator: ',', decimal_separator: '.', allow_decimal: true, require_decimal: false, digits_after_decimal: [2], allow_space_after_digits: false }.
Note: The array digits_after_decimal is filled with the exact number of digits allowed not a range, for example a range 1 to 3 will be given as [1, 2, 3].
isDataURI(str)check if the string is a data uri format.
isDate(str [, options])check if the string is a valid date. e.g. [2002-07-15, new Date()].

options is an object which can contain the keys format, strictMode and/or delimiters.

format is a string and defaults to YYYY/MM/DD.

strictMode is a boolean and defaults to false. If strictMode is set to true, the validator will reject strings different from format.

delimiters is an array of allowed date delimiters and defaults to ['/', '-'].
isDecimal(str [, options])check if the string represents a decimal number, such as 0.1, .3, 1.1, 1.00003, 4.0, etc.

options is an object which defaults to {force_decimal: false, decimal_digits: '1,', locale: 'en-US'}.

locale determines the decimal separator and is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'eo', 'es-ES', 'fa', 'fa-AF', 'fa-IR', 'fr-FR', 'fr-CA', 'hu-HU', 'id-ID', 'it-IT', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pl-Pl', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA', 'vi-VN'].
Note: decimal_digits is given as a range like '1,3', a specific value like '3' or min like '1,'.
isDivisibleBy(str, number)check if the string is a number that is divisible by another.
isEAN(str)check if the string is an EAN (European Article Number).
isEmail(str [, options])check if the string is an email.

options is an object which defaults to { allow_display_name: false, require_display_name: false, allow_utf8_local_part: true, require_tld: true, allow_ip_domain: false, allow_underscores: false, domain_specific_validation: false, blacklisted_chars: '', host_blacklist: [] }. If allow_display_name is set to true, the validator will also match Display Name <email-address>. If require_display_name is set to true, the validator will reject strings without the format Display Name <email-address>. If allow_utf8_local_part is set to false, the validator will not allow any non-English UTF8 character in email address' local part. If require_tld is set to false, email addresses without a TLD in their domain will also be matched. If ignore_max_length is set to true, the validator will not check for the standard max length of an email. If allow_ip_domain is set to true, the validator will allow IP addresses in the host part. If domain_specific_validation is true, some additional validation will be enabled, e.g. disallowing certain syntactically valid email addresses that are rejected by Gmail. If blacklisted_chars receives a string, then the validator will reject emails that include any of the characters in the string, in the name part. If host_blacklist is set to an array of strings or regexp, and the part of the email after the @ symbol matches one of the strings defined in it, the validation fails. If host_whitelist is set to an array of strings or regexp, and the part of the email after the @ symbol matches none of the strings defined in it, the validation fails.
isEmpty(str [, options])check if the string has a length of zero.

options is an object which defaults to { ignore_whitespace: false }.
isEthereumAddress(str)check if the string is an Ethereum address. Does not validate address checksums.
isFloat(str [, options])check if the string is a float.

options is an object which can contain the keys min, max, gt, and/or lt to validate the float is within boundaries (e.g. { min: 7.22, max: 9.55 }) it also has locale as an option.

min and max are equivalent to 'greater or equal' and 'less or equal', respectively while gt and lt are their strict counterparts.

locale determines the decimal separator and is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'eo', 'es-ES', 'fr-CA', 'fr-FR', 'hu-HU', 'it-IT', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']. Locale list is validator.isFloatLocales.
isFQDN(str [, options])check if the string is a fully qualified domain name (e.g. domain.com).

options is an object which defaults to { require_tld: true, allow_underscores: false, allow_trailing_dot: false, allow_numeric_tld: false, allow_wildcard: false, ignore_max_length: false }.

require_tld - If set to false the validator will not check if the domain includes a TLD.
allow_underscores - if set to true, the validator will allow underscores in the domain.
allow_trailing_dot - if set to true, the validator will allow the domain to end with a . character.
allow_numeric_tld - if set to true, the validator will allow the TLD of the domain to be made up solely of numbers.
allow_wildcard - if set to true, the validator will allow domains starting with *. (e.g. *.example.com or *.shop.example.com).
ignore_max_length - if set to true, the validator will not check for the standard max length of a domain.
isFreightContainerID(str)alias for isISO6346, check if the string is a valid ISO 6346 shipping container identification.
isFullWidth(str)check if the string contains any full-width chars.
isHalfWidth(str)check if the string contains any half-width chars.
isHash(str, algorithm)check if the string is a hash of type algorithm.

Algorithm is one of ['crc32', 'crc32b', 'md4', 'md5', 'ripemd128', 'ripemd160', 'sha1', 'sha256', 'sha384', 'sha512', 'tiger128', 'tiger160', 'tiger192'].
isHexadecimal(str)check if the string is a hexadecimal number.
isHexColor(str [, options])check if the string is a hexadecimal color.

options is an object that defaults to { require_hashtag: false }.
Options:
require_hashtag: Enforce # prefix, default false.
isHSL(str)check if the string is an HSL (hue, saturation, lightness, optional alpha) color based on CSS Colors Level 4 specification.

Comma-separated format supported. Space-separated format supported with the exception of a few edge cases (ex: hsl(200grad+.1%62%/1)).
isIBAN(str, [, options])check if the string is an IBAN (International Bank Account Number).

options is an object which accepts two attributes: whitelist: where you can restrict IBAN codes you want to receive data from and blacklist: where you can remove some of the countries from the current list. For both you can use an array with the following values ['AD','AE','AL','AT','AZ','BA','BE','BG','BH','BR','BY','CH','CR','CY','CZ','DE','DK','DO','EE','EG','ES','FI','FO','FR','GB','GE','GI','GL','GR','GT','HR','HU','IE','IL','IQ','IR','IS','IT','JO','KW','KZ','LB','LC','LI','LT','LU','LV','MC','MD','ME','MK','MR','MT','MU','MZ','NL','NO','PK','PL','PS','PT','QA','RO','RS','SA','SC','SE','SI','SK','SM','SV','TL','TN','TR','UA','VA','VG','XK'].
isIdentityCard(str [, locale])check if the string is a valid identity card code.

locale is one of ['LK', 'PL', 'ES', 'FI', 'IN', 'IT', 'IR', 'MZ', 'NO', 'TH', 'zh-TW', 'he-IL', 'ar-LY', 'ar-TN', 'zh-CN', 'zh-HK', 'PK'] OR 'any'. If 'any' is used, function will check if any of the locales match.

Defaults to 'any'.
isIMEI(str [, options]))check if the string is a valid IMEI number. IMEI should be of format ############### or ##-######-######-#.

options is an object which can contain the keys allow_hyphens. Defaults to first format. If allow_hyphens is set to true, the validator will validate the second format.
isIn(str, values)check if the string is in an array of allowed values.
isInt(str [, options])check if the string is an integer.

options is an object which can contain the keys min and/or max to check the integer is within boundaries (e.g. { min: 10, max: 99 }). options can also contain the key allow_leading_zeroes, which when set to false will disallow integer values with leading zeroes (e.g. { allow_leading_zeroes: false }). Finally, options can contain the keys gt and/or lt which will enforce integers being greater than or less than, respectively, the value provided (e.g. {gt: 1, lt: 4} for a number between 1 and 4).
isIP(str [, options])check if the string is an IP address (version 4 or 6).

options is an object that defaults to { version: '' }.

Options:
version: defines which IP version to compare to. Accepted values: 4, 6, '4', '6'.
isIPRange(str [, version])check if the string is an IP Range (version 4 or 6).
isISBN(str [, options])check if the string is an ISBN.

options is an object that has no default.
Options:
version: ISBN version to compare to. Accepted values are '10' and '13'. If none provided, both will be tested.
isISIN(str)check if the string is an ISIN (stock/security identifier).
isISO6346(str)check if the string is a valid ISO 6346 shipping container identification.
isISO6391(str)check if the string is a valid ISO 639-1 language code.
isISO8601(str [, options])check if the string is a valid ISO 8601 date.
options is an object which defaults to { strict: false, strictSeparator: false }. If strict is true, date strings with invalid dates like 2009-02-29 will be invalid. If strictSeparator is true, date strings with date and time separated by anything other than a T will be invalid.
isISO15924(str)check if the string is a valid ISO 15924 officially assigned script code.
isISO31661Alpha2(str [, options])check if the string is a valid ISO 3166-1 alpha-2 officially assigned country code.
options is an object which can contain the key userAssignedCodes: an array of custom codes that are not officially assigned (e.g. ['XK']).
isISO31661Alpha3(str [, options])check if the string is a valid ISO 3166-1 alpha-3 officially assigned country code.
options is an object which can contain the key userAssignedCodes: an array of custom codes that are not officially assigned (e.g. ['XXK']).
isISO31661Numeric(str)check if the string is a valid ISO 3166-1 numeric officially assigned country code.
isISO4217(str)check if the string is a valid ISO 4217 officially assigned currency code.
isISRC(str)check if the string is an ISRC.
isISSN(str [, options])check if the string is an ISSN.

options is an object which defaults to { case_sensitive: false, require_hyphen: false }. If case_sensitive is true, ISSNs with a lowercase 'x' as the check digit are rejected.
isJSON(str [, options])check if the string is valid JSON (note: uses JSON.parse).

options is an object which defaults to { allow_primitives: false, allow_any_value: false }. If allow_primitives is true, the primitives 'true', 'false' and 'null' are accepted as valid JSON values. If allow_any_value is true, any string that passes JSON.parse is considered valid.
isJWT(str)check if the string is valid JWT token.
isLatLong(str [, options])check if the string is a valid latitude-longitude coordinate in the format lat,long or lat, long.

options is an object that defaults to { checkDMS: false }. Pass checkDMS as true to validate DMS(degrees, minutes, and seconds) latitude-longitude format.
isLength(str [, options])check if the string's length falls in a range and equal to any of the integers of the discreteLengths array if provided.

options is an object which defaults to { min: 0, max: undefined, discreteLengths: undefined }. Note: this function takes into account surrogate pairs.
isLicensePlate(str, locale)check if the string matches the format of a country's license plate.

locale is one of ['cs-CZ', 'de-DE', 'de-LI', 'en-IN', 'en-SG', 'en-PK', 'es-AR', 'hu-HU', 'pt-BR', 'pt-PT', 'sq-AL', 'sv-SE'] or 'any'.
isLocale(str)check if the string is a locale.
isLowercase(str)check if the string is lowercase.
isLuhnNumber(str)check if the string passes the Luhn algorithm check.
isMACAddress(str [, options])check if the string is a MAC address.

options is an object which defaults to { no_separators: false }. It allows the use of hyphens, spaces or dots e.g. '01 02 03 04 05 ab', '01-02-03-04-05-ab' or '0102.0304.05ab'. If no_separators is true, the validator will then only check MAC addresses without separators. The options also allow a eui property to specify if it needs to be validated against EUI-48 or EUI-64. The accepted values of eui are: 48, 64.
isMagnetURI(str)check if the string is a Magnet URI format.
isMailtoURI(str, [, options])check if the string is a Mailto URI format.

options is an object of validating emails inside the URI (check isEmails options for details).
isMD5(str)check if the string is a MD5 hash.

Please note that you can also use the isHash(str, 'md5') function. Keep in mind that MD5 has some collision weaknesses compared to other algorithms (e.g., SHA).
isMimeType(str)check if the string matches to a valid MIME type format.
isMobilePhone(str [, locale [, options]])check if the string is a mobile phone number,

locale is either an array of locales (e.g. ['sk-SK', 'sr-RS']) OR one of ['am-Am', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-EH', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-PS', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'az-AZ', 'az-LB', 'az-LY', 'be-BY', 'bg-BG', 'bn-BD', 'bs-BA', 'ca-AD', 'cs-CZ', 'da-DK', 'de-AT', 'de-CH', 'de-DE', 'de-LU', 'dv-MV', 'dz-BT', 'el-CY', 'el-GR', 'en-AG', 'en-AI', 'en-AU', 'en-BM', 'en-BS', 'en-BW', 'en-CA', 'en-GB', 'en-GG', 'en-GH', 'en-GY', 'en-HK', 'en-IE', 'en-IN', 'en-JM', 'en-KE', 'en-KI', 'en-KN', 'en-LS', 'en-MO', 'en-MT', 'en-MU', 'en-MW', 'en-NG', 'en-NZ', 'en-PG', 'en-PH', 'en-PK', 'en-RW', 'en-SG', 'en-SL', 'en-SS', 'en-TZ', 'en-UG', 'en-US', 'en-ZA', 'en-ZM', 'en-ZW', 'es-AR', 'es-BO', 'es-CL', 'es-CO', 'es-CR', 'es-CU', 'es-DO', 'es-EC', 'es-ES', 'es-GT','es-HN', 'es-MX', 'es-NI', 'es-PA', 'es-PE', 'es-PY', 'es-SV', 'es-UY', 'es-VE', 'et-EE', 'fa-AF', 'fa-IR', 'fi-FI', 'fj-FJ', 'fo-FO', 'fr-BE', 'fr-BF', 'fr-BJ', 'fr-CD', 'fr-CF', 'fr-DJ', 'fr-FR', 'fr-GF', 'fr-GP', 'fr-MQ', 'fr-PF', 'fr-RE', 'fr-WF', 'ga-IE', 'he-IL', 'hu-HU', 'id-ID', 'ir-IR', 'it-IT', 'it-SM', 'ja-JP', 'ka-GE', 'kk-KZ', 'kl-GL', 'ko-KR', 'ky-KG', 'lt-LT', 'mg-MG', 'mn-MN', 'mk-MK', 'ms-MY', 'my-MM', 'mz-MZ', 'nb-NO', 'ne-NP', 'nl-AW', 'nl-BE', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-AO', 'pt-BR', 'pt-PT', 'ro-Md', 'ro-RO', 'ru-RU', 'si-LK', 'sk-SK', 'sl-SI', 'so-SO', 'sq-AL', 'sr-RS', 'sv-SE', 'tg-TJ', 'th-TH', 'tk-TM', 'tr-TR', 'uk-UA', 'uz-UZ', 'vi-VN', 'zh-CN', 'zh-HK', 'zh-MO', 'zh-TW'] OR defaults to 'any'. If 'any' or a falsey value is used, function will check if any of the locales match).

options is an optional object that can be supplied with the following keys: strictMode, if this is set to true, the mobile phone number must be supplied with the country code and therefore must start with +. Locale list is validator.isMobilePhoneLocales.
isMongoId(str)check if the string is a valid hex-encoded representation of a MongoDB ObjectId.
isMultibyte(str)check if the string contains one or more multibyte chars.
isNumeric(str [, options])check if the string contains only numbers.

options is an object which defaults to { no_symbols: false } it also has locale as an option. If no_symbols is true, the validator will reject numeric strings that feature a symbol (e.g. +, -, or .).

locale determines the decimal separator and is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'eo', 'es-ES', 'fr-FR', 'fr-CA', 'hu-HU', 'it-IT', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA'].
isOctal(str)check if the string is a valid octal number.
isPassportNumber(str, countryCode)check if the string is a valid passport number.

countryCode is one of ['AM', 'AR', 'AT', 'AU', 'AZ', 'BE', 'BG', 'BY', 'BR', 'CA', 'CH', 'CN', 'CY', 'CZ', 'DE', 'DK', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HU', 'IE', 'IN', 'IR', 'ID', 'IS', 'IT', 'JM', 'JP', 'KR', 'KZ', 'LI', 'LT', 'LU', 'LV', 'LY', 'MT', 'MX', 'MY', 'MZ', 'NL', 'NZ', 'PH', 'PK', 'PL', 'PT', 'RO', 'RU', 'SE', 'SL', 'SK', 'TH', 'TR', 'UA', 'US', 'ZA']. Locale list is validator.passportNumberLocales.
isPort(str)check if the string is a valid port number.
isPostalCode(str, locale)check if the string is a postal code.

locale is one of ['AD', 'AT', 'AU', 'AZ', 'BA', 'BD', 'BE', 'BG', 'BR', 'BY', 'CA', 'CH', 'CN', 'CO', 'CZ', 'DE', 'DK', 'DO', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IN', 'IR', 'IS', 'IT', 'JP', 'KE', 'KR', 'LI', 'LK', 'LT', 'LU', 'LV', 'MC', 'MG', 'MT', 'MX', 'MY', 'NL', 'NO', 'NP', 'NZ', 'PK', 'PL', 'PR', 'PT', 'RO', 'RU', 'SA', 'SE', 'SG', 'SI', 'SK', 'TH', 'TN', 'TW', 'UA', 'US', 'ZA', 'ZM'] OR 'any'. If 'any' is used, function will check if any of the locales match. Locale list is validator.isPostalCodeLocales.
isRFC3339(str)check if the string is a valid RFC 3339 date.
isRgbColor(str [,options])check if the string is a rgb or rgba color.

options is an object with the following properties

includePercentValues defaults to true. If you don't want to allow to set rgb or rgba values with percents, like rgb(5%,5%,5%), or rgba(90%,90%,90%,.3), then set it to false.

allowSpaces defaults to true, which prohibits whitespace. If set to false, whitespace between color values is allowed, such as rgb(255, 255, 255) or even rgba(255, 128, 0, 0.7).
isSemVer(str)check if the string is a Semantic Versioning Specification (SemVer).
isSurrogatePair(str)check if the string contains any surrogate pairs chars.
isUppercase(str)check if the string is uppercase.
isSlug(str)check if the string is of type slug.
isStrongPassword(str [, options])check if the string can be considered a strong password or not. Allows for custom requirements or scoring rules. If returnScore is true, then the function returns an integer score for the password rather than a boolean.
Default options:
{ minLength: 8, minLowercase: 1, minUppercase: 1, minNumbers: 1, minSymbols: 1, returnScore: false, pointsPerUnique: 1, pointsPerRepeat: 0.5, pointsForContainingLower: 10, pointsForContainingUpper: 10, pointsForContainingNumber: 10, pointsForContainingSymbol: 10 }
isTime(str [, options])check if the string is a valid time e.g. [23:01:59, new Date().toLocaleTimeString()].

options is an object which can contain the keys hourFormat or mode.

hourFormat is a key and defaults to 'hour24'.

mode is a key and defaults to 'default'.

hourFormat can contain the values 'hour12' or 'hour24', 'hour24' will validate hours in 24 format and 'hour12' will validate hours in 12 format.

mode can contain the values 'default', 'withSeconds', withOptionalSeconds, 'default' will validate HH:MM format, 'withSeconds' will validate the HH:MM:SS format, 'withOptionalSeconds' will validate 'HH:MM' and 'HH:MM:SS' formats.
isTaxID(str, locale)check if the string is a valid Tax Identification Number. Default locale is en-US.

More info about exact TIN support can be found in src/lib/isTaxID.js.

Supported locales: [ 'bg-BG', 'cs-CZ', 'de-AT', 'de-DE', 'dk-DK', 'el-CY', 'el-GR', 'en-CA', 'en-GB', 'en-IE', 'en-US', 'es-AR', 'es-ES', 'et-EE', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-FR', 'fr-LU', 'hr-HR', 'hu-HU', 'it-IT', 'lb-LU', 'lt-LT', 'lv-LV', 'mt-MT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-BR', 'pt-PT', 'ro-RO', 'sk-SK', 'sl-SI', 'sv-SE', 'uk-UA'].
isURL(str [, options])check if the string is a URL.

options is an object which defaults to { protocols: ['http','https','ftp'], require_tld: true, require_protocol: false, require_host: true, require_port: false, require_valid_protocol: true, allow_underscores: false, host_whitelist: false, host_blacklist: false, allow_trailing_dot: false, allow_protocol_relative_urls: false, allow_fragments: true, allow_query_components: true, disallow_auth: false, validate_length: true }.

protocols - valid protocols can be modified with this option.
require_tld - If set to false isURL will not check if the URL's host includes a top-level domain.
require_protocol - RECOMMENDED if set to true isURL will return false if protocol is not present in the URL. Without this setting, some malicious URLs cannot be distinguishable from a valid URL with authentication information.
require_host - if set to false isURL will not check if host is present in the URL.
require_port - if set to true isURL will check if port is present in the URL.
require_valid_protocol - isURL will check if the URL's protocol is present in the protocols option.
allow_underscores - if set to true, the validator will allow underscores in the URL.
host_whitelist - if set to an array of strings or regexp, and the domain matches none of the strings defined in it, the validation fails.
host_blacklist - if set to an array of strings or regexp, and the domain matches any of the strings defined in it, the validation fails.
allow_trailing_dot - if set to true, the validator will allow the domain to end with a . character.
allow_protocol_relative_urls - if set to true protocol relative URLs will be allowed.
allow_fragments - if set to false isURL will return false if fragments are present.
allow_query_components - if set to false isURL will return false if query components are present.
disallow_auth - if set to true, the validator will fail if the URL contains an authentication component, e.g. http://username:password@example.com.
validate_length - if set to false isURL will skip string length validation. max_allowed_length will be ignored if this is set as false.
max_allowed_length - if set, isURL will not allow URLs longer than the specified value (default is 2084 that IE maximum URL length).
isULID(str)check if the string is a ULID.
isUUID(str [, version])check if the string is an RFC9562 UUID.
version is one of '1'-'8', 'nil', 'max', 'all' or 'loose'. The 'loose' option checks if the string is a UUID-like string with hexadecimal values, ignoring RFC9565.
isVariableWidth(str)check if the string contains a mixture of full and half-width chars.
isVAT(str, countryCode)check if the string is a valid VAT number if validation is available for the given country code matching ISO 3166-1 alpha-2.

countryCode is one of ['AL', 'AR', 'AT', 'AU', 'BE', 'BG', 'BO', 'BR', 'BY', 'CA', 'CH', 'CL', 'CO', 'CR', 'CY', 'CZ', 'DE', 'DK', 'DO', 'EC', 'EE', 'EL', 'ES', 'FI', 'FR', 'GB', 'GT', 'HN', 'HR', 'HU', 'ID', 'IE', 'IL', 'IN', 'IS', 'IT', 'KZ', 'LT', 'LU', 'LV', 'MK', 'MT', 'MX', 'NG', 'NI', 'NL', 'NO', 'NZ', 'PA', 'PE', 'PH', 'PL', 'PT', 'PY', 'RO', 'RS', 'RU', 'SA', 'SE', 'SI', 'SK', 'SM', 'SV', 'TR', 'UA', 'UY', 'UZ', 'VE'].
isWhitelisted(str, chars)check if the string consists only of characters that appear in the whitelist chars.
matches(str, pattern [, modifiers])check if the string matches the pattern.

Either matches('foo', /foo/i) or matches('foo', 'foo', 'i').
Note: The pattern is not checked for possible ReDoS attacks. We do not recommend that the user can provide their own pattern.

Sanitizers

Here is a list of the sanitizers currently available.

SanitizerDescription
blacklist(input, chars)remove characters that appear in the blacklist. The characters are used in a RegExp and so you will need to escape some chars, e.g. blacklist(input, '\\[\\]').
escape(input)replace <, >, &, ', ", `, \ and / with HTML entities.
ltrim(input [, chars])trim characters from the left-side of the input.
normalizeEmail(email [, options])canonicalize an email address. (This doesn't validate that the input is an email, if you want to validate the email use isEmail beforehand).

options is an object with the following keys and default values:
  • all_lowercase: true - Transforms the local part (before the @ symbol) of all email addresses to lowercase. Please note that this may violate RFC 5321, which gives providers the possibility to treat the local part of email addresses in a case sensitive way (although in practice most - yet not all - providers don't). The domain part of the email address is always lowercased, as it is case insensitive per RFC 1035.
  • gmail_lowercase: true - Gmail addresses are known to be case-insensitive, so this switch allows lowercasing them even when all_lowercase is set to false. Please note that when all_lowercase is true, Gmail addresses are lowercased regardless of the value of this setting.
  • gmail_remove_dots: true: Removes dots from the local part of the email address, as Gmail ignores them (e.g. "john.doe" and "johndoe" are considered equal).
  • gmail_remove_subaddress: true: Normalizes addresses by removing "sub-addresses", which is the part following a "+" sign (e.g. "foo+bar@gmail.com" becomes "foo@gmail.com").
  • gmail_convert_googlemaildotcom: true: Converts addresses with domain @googlemail.com to @gmail.com, as they're equivalent.
  • outlookdotcom_lowercase: true - Outlook.com addresses (including Windows Live and Hotmail) are known to be case-insensitive, so this switch allows lowercasing them even when all_lowercase is set to false. Please note that when all_lowercase is true, Outlook.com addresses are lowercased regardless of the value of this setting.
  • outlookdotcom_remove_subaddress: true: Normalizes addresses by removing "sub-addresses", which is the part following a "+" sign (e.g. "foo+bar@outlook.com" becomes "foo@outlook.com").
  • yahoo_lowercase: true - Yahoo Mail addresses are known to be case-insensitive, so this switch allows lowercasing them even when all_lowercase is set to false. Please note that when all_lowercase is true, Yahoo Mail addresses are lowercased regardless of the value of this setting.
  • yahoo_remove_subaddress: true: Normalizes addresses by removing "sub-addresses", which is the part following a "-" sign (e.g. "foo-bar@yahoo.com" becomes "foo@yahoo.com").
  • icloud_lowercase: true - iCloud addresses (including MobileMe) are known to be case-insensitive, so this switch allows lowercasing them even when all_lowercase is set to false. Please note that when all_lowercase is true, iCloud addresses are lowercased regardless of the value of this setting.
  • icloud_remove_subaddress: true: Normalizes addresses by removing "sub-addresses", which is the part following a "+" sign (e.g. "foo+bar@icloud.com" becomes "foo@icloud.com").
rtrim(input [, chars])trim characters from the right-side of the input.
stripLow(input [, keep_new_lines])remove characters with a numerical value < 32 and 127, mostly control characters. If keep_new_lines is true, newline characters are preserved (\n and \r, hex 0xA and 0xD). Unicode-safe in JavaScript.
toBoolean(input [, strict])convert the input string to a boolean. Everything except for '0', 'false' and '' returns true. In strict mode only '1' and 'true' return true.
toDate(input)convert the input string to a date, or null if the input is not a date.
toFloat(input)convert the input string to a float, or NaN if the input is not a float.
toInt(input [, radix])convert the input string to an integer, or NaN if the input is not an integer.
trim(input [, chars])trim characters (whitespace by default) from both sides of the input.
unescape(input)replace HTML encoded entities with <, >, &, ', ", `, \ and /.
whitelist(input, chars)remove characters that do not appear in the whitelist. The characters are used in a RegExp and so you will need to escape some chars, e.g. whitelist(input, '\\[\\]').

XSS Sanitization

XSS sanitization was removed from the library in 2d5d6999.

For an alternative, have a look at Yahoo's xss-filters library or at DOMPurify.

Maintainers

Reading

Remember, validating can be troublesome sometimes. See A list of articles about programming assumptions commonly made that aren't true.

Contributing

We welcome contributions from the community! If you're interested in contributing to this project, please read our Contribution Guide to get started.

License

This project is licensed under the MIT. See the LICENSE file for details.