class-validator/esm5/decorator/string/IsPhoneNumber.js

Decorator-based property validation for classes.

import { buildMessage, ValidateBy } from '../common/ValidateBy';
import { parsePhoneNumber } from 'libphonenumber-js/max';
export var IS_PHONE_NUMBER = 'isPhoneNumber';
/**
 * Checks if the string is a valid phone number. To successfully validate any phone number the text must include
 * the intl. calling code, if the calling code wont be provided then the region must be set.
 *
 * @param value the potential phone number string to test
 * @param region 2 characters uppercase country code (e.g. DE, US, CH) for country specific validation.
 * If text doesn't start with the international calling code (e.g. +41), then you must set this parameter.
 */
export function isPhoneNumber(value, region) {
    if (typeof value !== 'string' || value.trim() !== value) {
        return false;
    }
    try {
        var phoneNumber = parsePhoneNumber(value, region);
        /**
         * We fail the validation if the user provided a region code
         * and it doesn't match with the country code of the parsed number.
         **/
        if (region && phoneNumber.country !== region) {
            return false;
        }
        return phoneNumber.isValid();
    }
    catch (error) {
        return false;
    }
}
/**
 * Checks if the string is a valid phone number. To successfully validate any phone number the text must include
 * the intl. calling code, if the calling code wont be provided then the region must be set.
 *
 * @param region 2 characters uppercase country code (e.g. DE, US, CH) for country specific validation.
 * If text doesn't start with the international calling code (e.g. +41), then you must set this parameter.
 */
export function IsPhoneNumber(region, validationOptions) {
    return ValidateBy({
        name: IS_PHONE_NUMBER,
        constraints: [region],
        validator: {
            validate: function (value, args) { return isPhoneNumber(value, args === null || args === void 0 ? void 0 : args.constraints[0]); },
            defaultMessage: buildMessage(function (eachPrefix) { return eachPrefix + '$property must be a valid phone number'; }, validationOptions),
        },
    }, validationOptions);
}
//# sourceMappingURL=IsPhoneNumber.js.map