question: IsPhoneNumber region is being used as country, is that ok?

[matgott]

I'm using IsPhoneNumber('US') to validate US numbers but for example a Puerto Rico phone number is returning false.

The problem:

Looking at isPhoneNumber decorator source code I saw this:

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;
}

So... basically a phone number from Puerto Rico is from the country PR but the region is US. The decorator is returning false is this the expected behavior?

For example this is the result from parsePhoneNumber for a Puerto Rico phone number:

{
  country: 'PR',
  countryCallingCode: '1',
  nationalNumber: '7876xxxxxx',
  number: '+17876xxxxxx',
  getMetadata: [Function (anonymous)],
  __countryCallingCodeSource: undefined
}

[Brakebein]

I stumbled across it after upgrading the library to version > 0.14.0, because some numbers are now rejected, although there were valid before. In version <= 0.14.0, region was behaving as a default, if no international calling code is provided, just like libphonenumber-js is doing it. With versoin >= 0.14.1, region is now restricting the number to the given country code (change introduced in bbb5d78).

This is actually a breaking change and is nowhere mentioned in the changelog!! It would be better to add a parameter/flag that controls if region should be only a default or restrictive, so that both use cases are covered.

The issue title could be renamed to "Breaking change in IsPhoneNumber behavior" to signal that this actually more serious.