DefinitelyTyped/validator/index.d.ts

// Type definitions for validator.js v5.7.0
// Project: https://github.com/chriso/validator.js
// Definitions by: tgfjt <https://github.com/tgfjt>, Ilya Mochalov <https://github.com/chrootsu>, Ayman Nedjmeddine <https://github.com/IOAyman>, Louy Alakkad <https://github.com/louy>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

declare namespace ValidatorJS {
  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" | "cs-CZ" | "de-DE" | "en-AU" | "en-GB" | "en-HK" | "en-IN" | "en-NZ" | "en-US" | "en-ZA" | "en-ZM" | "es-ES" | "fr-FR" | "hu-HU" | "nl-NL" | "pl-PL" | "pt-BR" | "pt-PT" | "ru-RU" | "sr-RS" | "sr-RS@latin" | "tr-TR";
  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" | "cs-CZ" | "de-DE" | "en-AU" | "en-GB" | "en-HK" | "en-IN" | "en-NZ" | "en-US" | "en-ZA" | "en-ZM" | "es-ES" | "fr-FR" | "fr-BE" | "hu-HU" | "nl-BE" | "nl-NL" | "pl-PL" | "pt-BR" | "pt-PT" | "ru-RU" | "sr-RS" | "sr-RS@latin" | "tr-TR";
  type MobilePhoneLocale = "ar-DZ" | "ar-SA" | "ar-SY" | "cs-CZ" | "de-DE" | "da-DK" | "el-GR" | "en-AU" | "en-GB" | "en-HK" | "en-IN" | "en-NZ" | "en-US" | "en-CA" | "en-ZA" | "en-ZM" | "es-ES" | "fi-FI" | "fr-FR" | "hu-HU" | "it-IT" | "ja-JP" | "ms-MY" | "nb-NO" | "nn-NO" | "pl-PL" | "pt-PT" | "ru-RU" | "sr-RS" | "tr-TR" | "vi-VN" | "zh-CN" | "zh-TW"

  interface ValidatorStatic {

    // **************
    // * Validators *
    // **************

    // check if the string contains the seed.
    contains(str: string, elem: any): boolean;

    // check if the string matches the comparison.
    equals(str: string, comparison: string): boolean;

    // check if the string is a date that's after the specified date (defaults to now).
    isAfter(str: string, date?: string): boolean;

    // 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',
    // 'cs-CZ', 'de-DE', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fr-FR', 'hu-HU',
    // 'nl-NL', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'sr-RS', 'sr-RS@latin', 'tr-TR']) and defaults to en-US
    isAlpha(str: string, locale?: AlphaLocale): boolean;

    // check if the string contains only letters and numbers. 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',
    // 'cs-CZ', 'de-DE', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fr-FR', 'hu-HU',
    // 'nl-NL', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'sr-RS', 'sr-RS@latin', 'tr-TR']) and defaults to en-US
    isAlphanumeric(str: string, locale?: AlphanumericLocale): boolean;

    // check if the string contains ASCII chars only.
    isAscii(str: string): boolean;

    // check if a string is base64 encoded.
    isBase64(str: string): boolean;

    // check if the string is a date that's before the specified date.
    isBefore(str: string, date?: string): boolean;

    // check if a string is a boolean.
    isBoolean(str: string): boolean;

    // check if the string's length (in bytes) falls in a range.
    isByteLength(str: string, options: IsByteLengthOptions): boolean;
    isByteLength(str: string, min: number, max?: number): boolean;

    // check if the string is a credit card.
    isCreditCard(str: string): boolean;

    // check if the string is a valid currency amount.
    isCurrency(str: string, options?: IsCurrencyOptions): boolean;

    // check if the string is a data uri format (https://developer.mozilla.org/en-US/docs/Web/HTTP/data_URIs)
    isDataURI(str: string): boolean;

    // check if the string is a date.
    isDate(str: string): boolean;

    // check if the string represents a decimal number, such as 0.1, .3, 1.1, 1.00003, 4.0, etc.
    isDecimal(str: string): boolean;

    // check if the string is a number that's divisible by another.
    isDivisibleBy(str: string, number: number): boolean;

    // check if the string is an email.
    isEmail(str: string, options?: IsEmailOptions): boolean;

    // check if the string has a length of zero.
    isEmpty(str: string): boolean;

    // check if the string is a fully qualified domain name (e.g. domain.com).
    isFQDN(str: string, options?: IsFQDNOptions): boolean;

    // check if the string is a float.
    isFloat(str: string, options?: IsFloatOptions): boolean;

    // check if the string contains any full-width chars.
    isFullWidth(str: string): boolean;

    // check if the string contains any half-width chars.
    isHalfWidth(str: string): boolean;

    // check if the string is a hexadecimal color.
    isHexColor(str: string): boolean;

    // check if the string is a hexadecimal number.
    isHexadecimal(str: string): boolean;

    // check if the string is an IP (version 4 or 6).
    isIP(str: string, version?: number): boolean;

    // check if the string is an ISBN (version 10 or 13).
    isISBN(str: string, version?: number): boolean;

    // check if the string is an ISIN (https://en.wikipedia.org/wiki/International_Securities_Identification_Number)
    // (stock/security identifier).
    isISIN(str: string): boolean;

    // check if the string is a valid ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) date.
    isISO8601(str: string): boolean;

    // check if the string is in a array of allowed values.
    isIn(str: string, values: any[]): boolean;

    // check if the string is an integer.
    isInt(str: string, options?: IsIntOptions): boolean;

    // check if the string is valid JSON (note: uses JSON.parse).
    isJSON(str: string): boolean;

    // check if the string's length falls in a range.
    // Note: this function takes into account surrogate pairs.
    isLength(str: string, options: IsLengthOptions): boolean;
    isLength(str: string, min: number, max?: number): boolean;

    // check if the string is lowercase.
    isLowercase(str: string): boolean;

    // check if the string is a MAC address.
    isMACAddress(str: string): boolean;

    // check if the string is a MD5 hash.
    isMD5(str: string): boolean;

    // check if the string is a mobile phone number, (locale is one of
    // ['ar-DZ', 'ar-SA', 'ar-SY', 'cs-CZ', 'de-DE', 'da-DK', 'el-GR', 'en-AU', 'en-GB', 'en-HK',
    // 'en-IN', 'en-NZ', 'en-US', 'en-CA', 'en-ZA', 'en-ZM', 'es-ES', 'fi-FI', 'fr-FR', 'hu-HU',
    // 'it-IT', 'ja-JP', 'ms-MY', 'nb-NO', 'nn-NO', 'pl-PL', 'pt-PT', 'ru-RU', 'sr-RS', 'tr-TR',
    // 'vi-VN', 'zh-CN', 'zh-TW']).
    isMobilePhone(str: string, locale: MobilePhoneLocale): boolean;

    // check if the string is a valid hex-encoded representation of a MongoDB ObjectId
    // (http://docs.mongodb.org/manual/reference/object-id/).
    isMongoId(str: string): boolean;

    // check if the string contains one or more multibyte chars.
    isMultibyte(str: string): boolean;

    // check if the string is null.
    isNull(str: string): boolean;

    // check if the string contains only numbers.
    isNumeric(str: string): boolean;

    // check if the string contains any surrogate pairs chars.
    isSurrogatePair(str: string): boolean;

    // check if the string is an URL.
    isURL(str: string, options?: IsURLOptions): boolean;

    // check if the string is a UUID. Must be one of ['3', '4', '5', 'all'], default is all.
    isUUID(str: string, version?: string | number): boolean;

    // check if the string is uppercase.
    isUppercase(str: string): boolean;

    // check if the string contains a mixture of full and half-width chars.
    isVariableWidth(str: string): boolean;

    // checks characters if they appear in the whitelist.
    isWhitelisted(str: string, chars: string | string[]): boolean;

    // check if string matches the pattern.
    matches(str: string, pattern: RegExp | string, modifiers?: string): boolean;

    // **************
    // * Sanitizers *
    // **************

    // 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, '\\[\\]').
    blacklist(input: string, chars: string): string;

    // replace <, >, &, ', " and / with HTML entities.
    escape(input: string): string;

    // replaces HTML encoded entities with <, >, &, ', " and /.
    unescape(input: string): string;

    // trim characters from the left-side of the input.
    ltrim(input: string, chars?: string): string;

    // canonicalize an email address.
    normalizeEmail(email: string, options?: NormalizeEmailOptions): string | false;

    // trim characters from the right-side of the input.
    rtrim(input: string, chars?: string): string;

    // 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.
    stripLow(input: string, keep_new_lines?: boolean): string;

    // convert the input to a boolean. Everything except for '0', 'false' and '' returns true. In strict mode only '1'
    // and 'true' return true.
    toBoolean(input: string, strict?: boolean): boolean;

    // convert the input to a date, or null if the input is not a date.
    toDate(input: string): Date; // Date or null

    // convert the input to a float, or NaN if the input is not a float.
    toFloat(input: string): number; // number or NaN

    // convert the input to an integer, or NaN if the input is not an integer.
    toInt(input: string, radix?: number): number; // number or NaN

    // trim characters (whitespace by default) from both sides of the input.
    trim(input: string, chars?: string): string;

    // 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, '\\[\\]').
    whitelist(input: string, chars: string): string;

    toString(input: any | any[]): string;
    
    version: string;

    // **************
    // * Extensions *
    // **************

    // add your own validators.
    // Note: that the first argument will be automatically coerced to a string.
    extend<T extends Function>(name: string, fn: T): void;
  }

  // options for IsByteLength
  interface IsByteLengthOptions {
    min?: number;
    max?: number;
  }

  // options for IsCurrency
  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_space_after_digits?: boolean;
  }

  // options for isEmail
  interface IsEmailOptions {
    allow_display_name?: boolean;
    allow_utf8_local_part?: boolean;
    require_tld?: boolean;
  }

  // options for isFQDN
  interface IsFQDNOptions {
    require_tld?: boolean;
    allow_underscores?: boolean;
    allow_trailing_dot?: boolean;
  }

  // options for IsFloat
  interface IsFloatOptions {
    min?: number;
    max?: number;
  }

  // options for IsInt
  interface IsIntOptions {
    min?: number;
    max?: number;
  }

  // options for IsLength
  interface IsLengthOptions {
    min?: number;
    max?: number;
  }

  // options for isURL
  interface IsURLOptions {
    protocols?: string[];
    require_tld?: boolean;
    require_protocol?: boolean;
    require_host: boolean;
    require_valid_protocol?: boolean;
    allow_underscores?: boolean;
    host_whitelist?: (string | RegExp)[];
    host_blacklist?: (string | RegExp)[];
    allow_trailing_dot?: boolean;
    allow_protocol_relative_urls?: boolean;
  }

  // options for normalizeEmail
  interface NormalizeEmailOptions {
    lowercase?: boolean;
    remove_dots?: boolean;
    remove_extension?: boolean;
  }
}

/**
 * MODULES
 */
declare var validator: ValidatorJS.ValidatorStatic;

declare module "validator" {
  export = validator;
}

declare module "validator/lib/blacklist" {
  const blacklist: typeof validator.blacklist;
  export = blacklist;
}

declare module "validator/lib/contains" {
  const contains: typeof validator.contains;
  export = contains;
}

declare module "validator/lib/equals" {
  const equals: typeof validator.equals;
  export = equals;
}

declare module "validator/lib/escape" {
  const escape: typeof validator.escape;
  export = escape;
}

declare module "validator/lib/isAfter" {
  const isAfter: typeof validator.isAfter;
  export = isAfter;
}

declare module "validator/lib/isAlpha" {
  const isAlpha: typeof validator.isAlpha;
  export = isAlpha;
}

declare module "validator/lib/isAlphanumeric" {
  const isAlphanumeric: typeof validator.isAlphanumeric;
  export = isAlphanumeric;
}

declare module "validator/lib/isAscii" {
  const isAscii: typeof validator.isAscii;
  export = isAscii;
}

declare module "validator/lib/isBase64" {
  const isBase64: typeof validator.isBase64;
  export = isBase64;
}

declare module "validator/lib/isBefore" {
  const isBefore: typeof validator.isBefore;
  export = isBefore;
}

declare module "validator/lib/isBoolean" {
  const isBoolean: typeof validator.isBoolean;
  export = isBoolean;
}

declare module "validator/lib/isByteLength" {
  const isByteLength: typeof validator.isByteLength;
  export = isByteLength;
}

declare module "validator/lib/isCreditCard" {
  const isCreditCard: typeof validator.isCreditCard;
  export = isCreditCard;
}

declare module "validator/lib/isCurrency" {
  const isCurrency: typeof validator.isCurrency;
  export = isCurrency;
}

declare module "validator/lib/isDataURI" {
  const isDataURI: typeof validator.isDataURI;
  export = isDataURI;
}

declare module "validator/lib/isDate" {
  const isDate: typeof validator.isDate;
  export = isDate;
}

declare module "validator/lib/isDecimal" {
  const isDecimal: typeof validator.isDecimal;
  export = isDecimal;
}

declare module "validator/lib/isDivisibleBy" {
  const isDivisibleBy: typeof validator.isDivisibleBy;
  export = isDivisibleBy;
}

declare module "validator/lib/isEmail" {
  const isEmail: typeof validator.isEmail;
  export = isEmail;
}

declare module "validator/lib/isEmpty" {
  const isEmpty: typeof validator.isEmpty;
  export = isEmpty;
}

declare module "validator/lib/isFQDN" {
  const isFQDN: typeof validator.isFQDN;
  export = isFQDN;
}

declare module "validator/lib/isFloat" {
  const isFloat: typeof validator.isFloat;
  export = isFloat;
}

declare module "validator/lib/isFullWidth" {
  const isFullWidth: typeof validator.isFullWidth;
  export = isFullWidth;
}

declare module "validator/lib/isHalfWidth" {
  const isHalfWidth: typeof validator.isHalfWidth;
  export = isHalfWidth;
}

declare module "validator/lib/isHexColor" {
  const isHexColor: typeof validator.isHexColor;
  export = isHexColor;
}

declare module "validator/lib/isHexadecimal" {
  const isHexadecimal: typeof validator.isHexadecimal;
  export = isHexadecimal;
}

declare module "validator/lib/isIP" {
  const isIP: typeof validator.isIP;
  export = isIP;
}

declare module "validator/lib/isISBN" {
  const isISBN: typeof validator.isISBN;
  export = isISBN;
}

declare module "validator/lib/isISIN" {
  const isISIN: typeof validator.isISIN;
  export = isISIN;
}

declare module "validator/lib/isISO8601" {
  const isISO8601: typeof validator.isISO8601;
  export = isISO8601;
}

declare module "validator/lib/isIn" {
  const isIn: typeof validator.isIn;
  export = isIn;
}

declare module "validator/lib/isInt" {
  const isInt: typeof validator.isInt;
  export = isInt;
}

declare module "validator/lib/isJSON" {
  const isJSON: typeof validator.isJSON;
  export = isJSON;
}

declare module "validator/lib/isLength" {
  const isLength: typeof validator.isLength;
  export = isLength;
}

declare module "validator/lib/isLowercase" {
  const isLowercase: typeof validator.isLowercase;
  export = isLowercase;
}

declare module "validator/lib/isMACAddress" {
  const isMACAddress: typeof validator.isMACAddress;
  export = isMACAddress;
}

declare module "validator/lib/isMD5" {
  const isMD5: typeof validator.isMD5;
  export = isMD5;
}

declare module "validator/lib/isMobilePhone" {
  const isMobilePhone: typeof validator.isMobilePhone;
  export = isMobilePhone;
}

declare module "validator/lib/isMongoId" {
  const isMongoId: typeof validator.isMongoId;
  export = isMongoId;
}

declare module "validator/lib/isMultibyte" {
  const isMultibyte: typeof validator.isMultibyte;
  export = isMultibyte;
}

declare module "validator/lib/isNull" {
  const isNull: typeof validator.isNull;
  export = isNull;
}

declare module "validator/lib/isNumeric" {
  const isNumeric: typeof validator.isNumeric;
  export = isNumeric;
}

declare module "validator/lib/isSurrogatePair" {
  const isSurrogatePair: typeof validator.isSurrogatePair;
  export = isSurrogatePair;
}

declare module "validator/lib/isURL" {
  const isURL: typeof validator.isURL;
  export = isURL;
}

declare module "validator/lib/isUUID" {
  const isUUID: typeof validator.isUUID;
  export = isUUID;
}

declare module "validator/lib/isUppercase" {
  const isUppercase: typeof validator.isUppercase;
  export = isUppercase;
}

declare module "validator/lib/isVariableWidth" {
  const isVariableWidth: typeof validator.isVariableWidth;
  export = isVariableWidth;
}

declare module "validator/lib/isWhitelisted" {
  const isWhitelisted: typeof validator.isWhitelisted;
  export = isWhitelisted;
}

declare module "validator/lib/ltrim" {
  const ltrim: typeof validator.ltrim;
  export = ltrim;
}

declare module "validator/lib/matches" {
  const matches: typeof validator.matches;
  export = matches;
}

declare module "validator/lib/normalizeEmail" {
  const normalizeEmail: typeof validator.normalizeEmail;
  export = normalizeEmail;
}

declare module "validator/lib/rtrim" {
  const rtrim: typeof validator.rtrim;
  export = rtrim;
}

declare module "validator/lib/stripLow" {
  const stripLow: typeof validator.stripLow;
  export = stripLow;
}

declare module "validator/lib/toBoolean" {
  const toBoolean: typeof validator.toBoolean;
  export = toBoolean;
}

declare module "validator/lib/toDate" {
  const toDate: typeof validator.toDate;
  export = toDate;
}

declare module "validator/lib/toFloat" {
  const toFloat: typeof validator.toFloat;
  export = toFloat;
}

declare module "validator/lib/toInt" {
  const toInt: typeof validator.toInt;
  export = toInt;
}

declare module "validator/lib/trim" {
  const trim: typeof validator.trim;
  export = trim;
}

declare module "validator/lib/unescape" {
  const unescape: typeof validator.unescape;
  export = unescape;
}

declare module "validator/lib/whitelist" {
  const whitelist: typeof validator.whitelist;
  export = whitelist;
}

// deprecated interfaces for backward compatibility, please use ValidatorJS.* instead the ones
interface IValidatorStatic extends ValidatorJS.ValidatorStatic { }
interface IURLoptions extends ValidatorJS.IsURLOptions { }
interface IFQDNoptions extends ValidatorJS.IsFQDNOptions { }
interface IEmailoptions extends ValidatorJS.NormalizeEmailOptions { }