Add an en-CA alias to isMobilePhone, closes #524

CHANGELOG.md

@@ -4,6 +4,8 @@
   ([#532](https://github.com/chriso/validator.js/pull/532))
 - Adjust Chinese mobile phone validation
   ([#523](https://github.com/chriso/validator.js/pull/523))
+- Added a Canadian locale to `isMobilePhone()`
+  ([#524](https://github.com/chriso/validator.js/issues/524))
 
 #### 5.2.0
 

README.md

@@ -85,7 +85,7 @@ Passing anything other than a string is an error.
 - **isLength(str, options)** - check if the string's length falls in a range. `options` is an object which defaults to `{min:0, max: undefined}`. Note: this function takes into account surrogate pairs.
 - **isLowercase(str)** - check if the string is lowercase.
 - **isMACAddress(str)** - check if the string is a MAC address.
-- **isMobilePhone(str, locale)** - check if the string is a mobile phone number, (locale is one of `['ar-SY', 'cs-CZ', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fi-FI', 'fr-FR', 'ms-MY', 'nb-NO', 'nn-NO', 'pt-PT', 'ru-RU', 'tr-TR', 'vi-VN', 'zh-CN', 'zh-TW']`).
+- **isMobilePhone(str, locale)** - check if the string is a mobile phone number, (locale is one of `['ar-SY', 'cs-CZ', 'de-DE', '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', 'ms-MY', 'nb-NO', 'nn-NO', 'pt-PT', 'ru-RU', 'tr-TR', 'vi-VN', 'zh-CN', 'zh-TW']`).
 - **isMongoId(str)** - check if the string is a valid hex-encoded representation of a [MongoDB ObjectId][mongoid].
 - **isMultibyte(str)** - check if the string contains one or more multibyte chars.
 - **isNull(str)** - check if the string is null (has a length of zero).

lib/isMobilePhone.js

@@ -41,6 +41,9 @@ var phones = {
 };
 /* eslint-enable max-len */
 
+// aliases
+phones['en-CA'] = phones['en-US'];
+
 function isMobilePhone(str, locale) {
   (0, _assertString2.default)(str);
   if (locale in phones) {

src/lib/isMobilePhone.js

@@ -30,6 +30,9 @@ const phones = {
 };
 /* eslint-enable max-len */
 
+// aliases
+phones['en-CA'] = phones['en-US'];
+
 export default function isMobilePhone(str, locale) {
   assertString(str);
   if (locale in phones) {

test/validators.js

@@ -2024,6 +2024,25 @@ describe('Validators', function () {
       ],
       args: ['en-US'],
     });
+    test({
+      validator: 'isMobilePhone',
+      valid: [
+        '19876543210',
+        '8005552222',
+        '+15673628910',
+      ],
+      invalid: [
+        '564785',
+        '0123456789',
+        '1437439210',
+        '8009112340',
+        '+10345672645',
+        '11435213543',
+        '2436119753',
+        '16532116190',
+      ],
+      args: ['en-CA'],
+    });
 
     test({
       validator: 'isMobilePhone',

validator.js

@@ -888,6 +888,9 @@
       };
       /* eslint-enable max-len */
 
+      // aliases
+      phones['en-CA'] = phones['en-US'];
+
       function isMobilePhone(str, locale) {
         assertString(str);
         if (locale in phones) {