| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377 |
- export type URLProtocol = 'http' | 'https' | 'ftp' | string;
- export type UUIDVersion = 1 | 2 | 3 | 4 | 5 | 7 | '1' | '2' | '3' | '4' | '5' | '7' | 'all' | 'loose';
- export type IPVersion = 4 | 6;
- export type AlphaLocale = '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' | 'az-AZ' | 'bg-BG' | 'bn-BD' | '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' | 'eo' | 'fa-AF' | 'fa-IR' | 'fi-FI' | 'fr-FR' | 'gu-IN' | 'he' | 'hi-IN' | 'hu-HU' | 'id-ID' | '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' | 'vi-VN';
- export type AlphanumericLocale = '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' | 'az-AZ' | 'bg-BG' | 'bn-BD' | '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' | 'eo' | 'fa-AF' | 'fa-IR' | 'fi-FI' | 'fr-FR' | 'fr-BE' | 'gu-IN' | 'he' | 'hi-IN' | 'hu-HU' | 'it-IT' | 'id-ID' | 'ja-JP' | 'kk-KZ' | 'kn-IN' | 'ko-KR' | 'ku-IQ' | 'ml-IN' | 'nb-NO' | 'nl-BE' | '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' | 'vi-VN';
- export type MobilePhoneLocale = 'any' | 'am-AM' | 'ar-AE' | 'ar-BH' | 'ar-DZ' | 'ar-EG' | 'ar-EH' | 'ar-IQ' | 'ar-JO' | 'ar-KW' | 'ar-LB' | 'ar-LY' | 'ar-MA' | 'ar-OM' | 'ar-QA' | 'ar-PS' | 'ar-SA' | 'ar-SD' | 'ar-SY' | 'ar-TN' | 'ar-YE' | 'az-AZ' | 'be-BY' | 'bg-BG' | 'bn-BD' | 'bs-BA' | 'cs-CZ' | 'de-AT' | 'de-CH' | 'de-DE' | 'de-LU' | 'da-DK' | '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-HN' | 'en-IE' | 'en-IN' | 'en-JM' | 'en-KE' | 'en-KI' | 'en-KN' | 'en-LS' | 'en-MT' | 'en-MU' | 'en-MW' | 'en-NA' | '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-CH' | 'fr-CM' | '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-CH' | 'it-IT' | 'it-SM' | 'ja-JP' | 'ka-GE' | 'kk-KZ' | 'kl-GL' | 'ko-KR' | 'ky-KG' | 'lt-LT' | 'lv-LV' | 'mg-MG' | 'mk-MK' | 'mn-MN' | 'ms-MY' | 'my-MM' | 'mz-MZ' | 'nb-NO' | 'nl-AW' | 'nl-BE' | 'nl-NL' | 'ne-NP' | '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-TW';
- export type PostalCodeLocale = 'any' | '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' | 'IL' | 'IN' | 'IR' | 'IS' | 'IT' | 'JP' | 'KE' | 'KR' | 'LI' | 'LK' | 'LT' | 'LU' | 'LV' | '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';
- export type HashAlgorithm = 'md4' | 'md5' | 'sha1' | 'sha256' | 'sha384' | 'sha512' | 'ripemd128' | 'ripemd160' | 'tiger128' | 'tiger160' | 'tiger192' | 'crc32' | 'crc32b';
- export type IBANCode = 'AD' | 'AE' | 'AL' | 'AT' | 'AZ' | 'BA' | 'BE' | 'BG' | 'BH' | 'BR' | 'BY' | 'CH' | 'CR' | 'CY' | 'CZ' | 'DE' | 'DK' | 'DO' | 'DZ' | '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';
- export interface IsIBANOptions {
- whitelist?: readonly IBANCode[];
- blacklist?: readonly IBANCode[];
- }
- export type IdentityCardLocale = 'any' | 'ar-LY' | 'ar-TN' | 'ES' | 'FI' | 'he-IL' | 'hk-HK' | 'IN' | 'IT' | 'IR' | 'MZ' | 'NO' | 'PK' | 'PL' | 'TH' | 'zh-CN' | 'zh-TW';
- export type PassportCountryCode = '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' | 'ID' | 'IE' | 'IN' | 'IR' | 'IS' | 'IT' | 'JM' | 'JP' | 'KR' | 'KZ' | 'LI' | 'LT' | 'LU' | 'LV' | 'LY' | 'MT' | 'MY' | 'MZ' | 'NL' | 'NZ' | 'PH' | 'PK' | 'PL' | 'PO' | 'PT' | 'RO' | 'RU' | 'SE' | 'SL' | 'SK' | 'TH' | 'TR' | 'UA' | 'US' | 'ZA';
- export type IsLicensePlateLocale = 'cs-CZ' | 'de-DE' | 'de-LI' | 'en-NI' | 'en-PK' | 'en-SG' | 'es-AR' | 'fi-FI' | 'hu-HU' | 'pt-BR' | 'pt-PT' | 'sq-AL' | 'sv-SE' | 'any';
- export type TaxIDLocale = '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-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';
- export type VATCountryCode = 'GB' | 'IT' | 'NL' | 'AT' | 'BE' | 'BG' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'EE' | 'FI' | 'FR' | 'DE' | 'EL' | 'HU' | 'IE' | 'LV' | 'LT' | 'LU' | 'MT' | 'PL' | 'PT' | 'RO' | 'SK' | 'SI' | 'ES' | 'SE' | 'AL' | 'MK' | 'AU' | 'BY' | 'CA' | 'IS' | 'IN' | 'ID' | 'IL' | 'KZ' | 'NZ' | 'NG' | 'NO' | 'PH' | 'RU' | 'SM' | 'SA' | 'RS' | 'CH' | 'TR' | 'UA' | 'UZ' | 'AR' | 'BO' | 'BR' | 'CL' | 'CO' | 'CR' | 'EC' | 'SV' | 'GT' | 'HN' | 'MX' | 'NI' | 'PA' | 'PY' | 'PE' | 'DO' | 'UY' | 'VE';
- export interface MinMaxOptions {
- min?: number;
- max?: number;
- }
- export interface MinMaxExtendedOptions extends MinMaxOptions {
- lt?: number;
- gt?: number;
- }
- /**
- * defaults to
- * {
- * ignoreCase: false|
- * minOccurrences: 1
- * }
- */
- export interface ContainsOptions {
- ignoreCase?: boolean;
- minOccurrences?: number;
- }
- /**
- * defaults to
- * {
- * comparisonDate: Date().toString()
- * }
- */
- export interface IsAfterOptions {
- comparisonDate?: string;
- }
- export interface IsAlphaOptions {
- ignore?: string | string[] | RegExp;
- }
- export interface IsAlphanumericOptions {
- ignore?: string | RegExp;
- }
- /**
- * defaults to
- * {
- * crockford: false
- * }
- */
- export interface IsBase32Options {
- crockford?: boolean;
- }
- /**
- * defaults to
- * {
- * urlSafe: false
- * }
- */
- export interface IsBase64Options {
- urlSafe?: boolean;
- }
- /**
- * defaults to
- * {
- * comparisonDate: new Date().toString()
- * }
- */
- export interface IsBeforeOptions {
- comparisonDate?: string;
- }
- /**
- * defaults to
- * {
- * strict: false
- * loose: false
- * }
- */
- export interface IsBooleanOptions {
- strict?: boolean;
- loose?: boolean;
- }
- /**
- * defaults to
- * {
- * includePercentValues: true
- * allowSpaces: true
- * }
- */
- export interface IsRgbColorOptions {
- includePercentValues?: boolean;
- allowSpaces?: boolean;
- }
- export interface IsCreditCard {
- provider?: 'amex' | 'dinersclub' | 'discover' | 'jcb' | 'mastercard' | 'unionpay' | 'visa';
- }
- /**
- * 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_space_after_digits: false
- * }
- */
- export interface IsCurrencyOptions {
- symbol?: string;
- require_symbol?: boolean;
- allow_space_after_symbol?: boolean;
- symbol_after_digits?: boolean;
- allow_negatives?: boolean;
- parens_for_negatives?: boolean;
- negative_sign_before_digits?: boolean;
- negative_sign_after_digits?: boolean;
- allow_negative_sign_placeholder?: boolean;
- thousands_separator?: string;
- decimal_separator?: string;
- allow_decimal?: boolean;
- require_decimal?: boolean;
- digits_after_decimal?: number[];
- allow_space_after_digits?: boolean;
- }
- /**
- * defaults to
- * {
- * format: 'YYYY/MM/DD'|
- * delimiters: ['/'| '-']|
- * strictMode: false
- * }
- */
- export interface IsDateOptions {
- format?: string;
- delimiters?: string[];
- strictMode?: boolean;
- }
- export interface IsDecimalOptions {
- decimal_digits?: string;
- force_decimal?: boolean;
- locale?: AlphanumericLocale;
- blacklisted_chars?: string;
- }
- export interface IsEmailOptions {
- allow_display_name?: boolean;
- allow_underscores?: boolean;
- allow_utf8_local_part?: boolean;
- require_tld?: boolean;
- ignore_max_length?: boolean;
- allow_ip_domain?: boolean;
- domain_specific_validation?: boolean;
- blacklisted_chars?: string;
- host_blacklist?: (string | RegExp)[];
- host_whitelist?: (string | RegExp)[];
- }
- /**
- * defaults to
- * {
- * ignore_whitespace: false
- * }
- */
- export interface IsEmptyOptions {
- ignore_whitespace: boolean;
- }
- export interface IsFloatOptions extends MinMaxExtendedOptions {
- locale?: AlphanumericLocale;
- }
- /**
- * defaults to
- * {
- * require_tld: true|
- * allow_underscores: false|
- * allow_trailing_dot: false|
- * allow_numeric_tld: false|
- * allow_wildcard: false|
- * ignore_max_length: false
- * }
- */
- export interface IsFQDNOptions {
- require_tld?: boolean;
- allow_underscores?: boolean;
- allow_trailing_dot?: boolean;
- allow_numeric_tld?: boolean;
- allow_wildcard?: boolean;
- ignore_max_length?: boolean;
- }
- export interface IsIntOptions extends MinMaxExtendedOptions {
- allow_leading_zeroes?: boolean;
- }
- /**
- * defaults to
- * {
- * allow_primitives: false
- * }
- */
- export interface IsJSONOptions {
- allow_primitives?: boolean;
- }
- /**
- * defaults to
- * {
- * checkDMS: false
- * }
- */
- export interface IsLatLongOptions {
- checkDMS?: boolean;
- }
- export interface IsLengthOptions extends MinMaxOptions {
- discreteLengths?: number[];
- }
- /**
- * defaults to
- * {
- * allow_hyphens: false
- * }
- */
- export interface IsIMEIOptions {
- allow_hyphens?: boolean;
- }
- /**
- * defaults to
- * {
- * strict: false|
- * strictSeparator: false
- * }
- */
- export interface IsISO8601Options {
- strict?: boolean;
- strictSeparator?: boolean;
- }
- export interface IsISBNOptions {
- version?: '10' | '13';
- }
- /**
- * defaults to
- * {
- * case_sensitive: false|
- * require_hyphen: false
- * }
- */
- export interface IsISSNOptions {
- case_sensitive?: boolean;
- require_hyphen?: boolean;
- }
- /**
- * defaults to
- * ```js
- * {
- * no_separators: false
- * }
- * ```
- */
- export interface IsMACAddressOptions {
- no_separators?: boolean;
- /**
- * @deprecated use `no_separators` instead
- */
- no_colons?: boolean;
- eui?: '48' | '64';
- }
- export interface IsMobilePhoneOptions {
- strictMode?: boolean;
- }
- /**
- * defaults to
- * {
- * no_symbols: false
- * }
- */
- export interface IsNumericOptions {
- no_symbols: boolean;
- locale?: AlphanumericLocale;
- }
- /**
- * defaults to
- * {
- * 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
- * }
- */
- export interface IsStrongPasswordOptions {
- minLength?: number;
- minLowercase?: number;
- minUppercase?: number;
- minNumbers?: number;
- minSymbols?: number;
- returnScore?: boolean;
- pointsPerUnique?: number;
- pointsPerRepeat?: number;
- pointsForContainingLower?: number;
- pointsForContainingUpper?: number;
- pointsForContainingNumber?: number;
- pointsForContainingSymbol?: number;
- }
- /**
- * 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|
- * validate_length: true|
- * allow_fragments: true|
- * allow_query_components: true
- * }
- */
- export interface IsURLOptions extends IsFQDNOptions {
- protocols?: URLProtocol[];
- require_protocol?: boolean;
- require_host?: boolean;
- require_port?: boolean;
- require_valid_protocol?: boolean;
- host_whitelist?: (string | RegExp)[];
- host_blacklist?: (string | RegExp)[];
- allow_protocol_relative_urls?: boolean;
- disallow_auth?: boolean;
- validate_length?: boolean;
- max_allowed_length?: number;
- allow_fragments?: boolean;
- allow_query_components?: boolean;
- }
- /**
- * defaults to
- * {
- * hourFormat: 'hour24'|
- * mode: 'default'|
- * };
- */
- export interface IsTimeOptions {
- hourFormat?: 'hour24' | 'hour12';
- mode?: 'default' | 'withSeconds';
- }
- export interface NormalizeEmailOptions {
- all_lowercase?: boolean;
- gmail_lowercase?: boolean;
- gmail_remove_dots?: boolean;
- gmail_remove_subaddress?: boolean;
- gmail_convert_googlemaildotcom?: boolean;
- outlookdotcom_lowercase?: boolean;
- outlookdotcom_remove_subaddress?: boolean;
- yahoo_lowercase?: boolean;
- yahoo_remove_subaddress?: boolean;
- icloud_lowercase?: boolean;
- icloud_remove_subaddress?: boolean;
- yandex_convert_yandexru?: boolean;
- }
|