A library for validating and sanitizing strings, Official port of the popular validator.js
This library validates and sanitizes strings only.
import validator from "https://deno.land/x/validator_deno/mod.ts";
validator.isEmail('[email protected]'); //=> trueHere is a list of the validators currently available.
| Validator | Description |
|---|---|
| contains(str, seed [, options]) | Check if the string contains the seed.options is an object which defaults to { ignoreCase: false }. |
| equals(str, comparison [, options]) | Check if the string matches the comparison.options is an object which defaults to { trim: false, ignoreCase: false }. |
| isAfter(str [, date]) | Check if the string is a date that's after the specified date (defaults to now). |
| isAlpha(str [, locale]) | Check if the string contains only alphabets depending on the locale. 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', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fa-IR', 'fr-FR', 'he', 'hu-HU', 'it-IT', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pl-Pl', 'pt-BR', 'pt-PT', 'ru-RU', 'sk-SK', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA'] and defaults to en-US. Locale list can be accessed via validator.isAlphaLocales |
| isAlphanumeric(str [, locale]) | Check if the string contains only alphabets and digits depending on the locale. 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', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fa-IR', 'fr-FR', 'he', 'hu-HU', 'it-IT', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pl-Pl', 'pt-BR', 'pt-PT', 'ru-RU', 'sk-SK', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA'] and defaults to en-US. Locale list can be accessed via validator.isAlphanumericLocales |
| isAscii(str) | Check if the string contains ASCII chars only. |
| isBase32(str) | Check if a string is base32 encoded. |
| isBase64(str [, options]) | Check if a string is base64 encoded.options is an object which defaults to { urlSafe: false }. |
| isBefore(str [, date]) | Check if the string is a date that's before the specified date (defaults to now). |
| isBIC(str) | Check if a string is a BIC (Bank Identification Code) or SWIFT code. |
| isBoolean(str) | Check if a string is a boolean. |
| 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) | Check if the string is a valid Credit Card number. |
| isCurrency(str) | 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 in Data URI format. |
| isDate(str [, format]) | Check if the string is a valid date. Example [2002-07-15, new Date()].format is a string that defaults to YYYY/MM/DD |
| 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 determine 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', 'es-ES', 'fr-FR', 'hu-HU', 'it-IT', 'ku-IQ', 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'].Note: decimal_digits is given as a range like '1,3', a specific value like '3' or min like '1,'. |
| isDivisibleBy(dividend, divisor) | Check if the dividend is a number that's divisible by the divisor. |
| 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, domain_specific_validation: false }.allow_display_name: If set to true, the validator will also match Display Name <email-address>.require_display_name: If set to true, the validator will reject strings without the format Display Name <email-address>.allow_utf8_local_part: If set to false, the validator will not allow any non-English UTF8 character in email address' local part.require_tld: If set to false, e-mail addresses without having TLD in their domain will also be matched.ignore_max_length: If set to true, the validator will not check for the standard max length of an email.allow_ip_domain: If set to true, the validator will allow IP addresses in the host part. domain_specific_validation If true, some additional validation will be enabled, e.g. disallowing certain syntactically valid email addresses that are rejected by GMail. |
| 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 ['md4', 'md5', 'sha1', 'sha256', 'sha384', 'sha512', 'ripemd128', 'ripemd160', 'tiger128', 'tiger160', 'tiger192', 'crc32', 'crc32b'] |
| isHexadecimal(str) | Check if the string is a hexadecimal number. |
| isHexColor(str) | Check if the string is a hexadecimal color. |
| isEmpty(str [, options]) | Check if the string has a length of zero. options is an object which defaults to { ignoreWhitespace:false }. |
| isEtheriumAddress(str) | Check if the string is an Ethereum address using basic regex. Does not validate address checksums. |
| isIdentityCard(str [, locale]) | Check if the string is a valid identity card code.locale is one of ['ES', 'IN', 'NO', 'zh-TW', 'he-IL', 'ar-TN', 'zh-CN'] OR any. If any is used, function will check if any of the locals match.Defaults to any. |
| 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: 1, max: 99 }). options can also contain the key allow_leading_zeroes, which when set to false will not allow 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 [, version]) | Check if the string is a valid IP address (version 4 or 6) |
| isISO31661Alpha2(str) | Check if the string is a valid ISO 3166-1 alpha-2 officially assigned country code. |
| isISO31661Alpha3(str) | Check if the string is a valid ISO 3166-1 alpha-3 officially assigned country code. |
| isISRC(str) | Check if the string is an ISRC. |
| isJWT(str) | Check if the string is a JWT. |
| isLocale(str) | Check if the string is locale. |
| isLowerCase(str) | Check if the string is lowercase. |
| isPort(str) | Check if the string is a valid network port number. |
| isSemVer(str) | Check if the string is a Semantic Versioning Specification (SemVer). |
| isURL(str, [options]) | Check if the string is an URL.options is an object which defaults to { protocols: ['http','https','ftp'], require_tld: true, require_protocol: false, require_host: true, require_valid_protocol: true, allow_underscores: false, host_whitelist: [], host_blacklist: [], allow_trailing_dot: false, allow_protocol_relative_urls: false, disallow_auth: false }.require_protocol: If set as true isURL will return false if protocol is not present in the URL.require_valid_protocol: isURL will check if the URL's protocol is present in the protocols option.protocols: valid protocols can be modified with this option.require_host: if set as false isURL will not check if host is present in the URL.allow_protocol_relative_urls: if set as true protocol relative URLs will be allowed.host_whitelist: List of allowed urls. Only those matching perfectly will be valid.host_blacklist: List of urls that are not allowed. All other valid url will return true. |
| isUpperCase(str) | Check if the string is uppercase. |
| isUUID(str [, version]) | Check if the string is a UUID (version 3, 4 or 5). If version is not specified, it will check for all versions. |
| isVariableWidth(str) | Check if the string contains a mixture of full and half-width characters. |
| matches(str, pattern [, modifiers]) | Check if string matches the pattern. Either matches('foo', /foo/i) or matches('foo', 'foo', 'i'). |
In general, we follow the "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Work on your fork
- Make your changes and additions
- Most of your changes should be focused on
src/andtest/folders and/orREADME.md.
- Most of your changes should be focused on
- Change or add tests if needed
- Run tests and make sure they pass
- Add changes to README.md if needed
- Format files with deno fmt
- Make your changes and additions
- Commit changes to your own branch
- Make sure you merge the latest from "upstream" and resolve conflicts if there is any
- Repeat step 3(3) above
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
Tests are using deno test, to run the tests use:
$ deno test