libphonenumbers - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

package.json

 {
   "name": "libphonenumbers",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "JavaScript port of Google's libphonenumber library for parsing, formatting, and validating international phone numbers in Node.js.",
   "author": "Bunlong <[e-mail]>",
   "license": "MIT",
-  "homepage": "https://github.com/Bunlong/libphonenumbers",
+  "homepage": "https://libphonenumbers.js.org",
   "bugs": {
@@ -9,0 +9,0 @@ "url": "https://github.com/Bunlong/libphonenumbers.git/issues"

README.md

 <p align="center">
-  <img src="https://raw.githubusercontent.com/Bunlong/libphonenumbers/main/static/images/libphonenumbers.png" alt="libphonenumbers" />
+  <img src="https://raw.githubusercontent.com/Bunlong/libphonenumbers/main/static/images/libphonenumbers-mini.png" alt="libphonenumbers" />
 </p>
@@ -18,29 +18,20 @@
 * PhoneNumberUtil
-  * [format(number, numberFormat)](#-formatnumber-numberformat)
-  * [formatInOriginalFormat(number, regionCallingFrom)](#-formatinoriginalformatnumber-regioncallingfrom)
-  * [formatOutOfCountryCallingNumber(number, regionCallingFrom)](#-formatoutofcountrycallingnumbernumber-regioncallingfrom)
-  * [getNumberType(number)](#-getnumbertypenumber)
-  * [getRegionCodeForNumber(number)](#-getregioncodefornumbernumber)
-  * [isPossibleNumber(number)](#-ispossiblenumbernumber)
-  * [isValidNumber(number)](#-isvalidnumbernumber)
-  * [isValidNumberForRegion(number, regionCode)](#-isvalidnumberforregionnumber-regioncode)
-  * [parseAndKeepRawInput(numberToParse, defaultRegion)](#-parseandkeeprawinputnumbertoparse-defaultregion)
-  * [parse(numberToParse, defaultRegion)](#-parsenumbertoparse-defaultregion)
+  * [format(number, numberFormat)](#-formatnumber-numberformat) is used to formats a phone number in the specified format using default rules.
+  * [formatInOriginalFormat(number, regionCallingFrom)](#-formatinoriginalformatnumber-regioncallingfrom) is used to formats a phone number using the original phone number format that the number is parsed from.
+  * [formatOutOfCountryCallingNumber(number, regionCallingFrom)](#-formatoutofcountrycallingnumbernumber-regioncallingfrom) is used to formats a phone number for out-of-country dialing purposes.
+  * [getNumberType(number)](#-getnumbertypenumber) is used to gets the type of a valid phone number.
+  * [getRegionCodeForNumber(number)](#-getregioncodefornumbernumber) is used to gets the region where a phone number is from.
+  * [isPossibleNumber(number)](#-ispossiblenumbernumber) is used to checks whether a phone number is possible.
+  * [isValidNumber(number)](#-isvalidnumbernumber) is used to checks whether a phone number matches a valid pattern.
+  * [isValidNumberForRegion(number, regionCode)](#-isvalidnumberforregionnumber-regioncode) is used to checks whether a phone number is valid for a certain region.
+  * [parseAndKeepRawInput(numberToParse, defaultRegion)](#-parseandkeeprawinputnumbertoparse-defaultregion) is used to parses a string and returns it in prototype buffer format while keeping the raw input value.
+  * [parse(numberToParse, defaultRegion)](#-parsenumbertoparse-defaultregion) is used to parses a string and returns it in proto buffer format.
 
-* ShortNumberInfo
-  * [connectsToEmergencyNumber(number, regionCode)](#-connectstoemergencynumbernumber-regioncode)
-  * [isPossibleShortNumber(number)](#-ispossibleshortnumbernumber)
-  * [isPossibleShortNumberForRegion(number, regionDialingFrom)](#-ispossibleshortnumberforregionnumber-regiondialingfrom)
-  * isValidShortNumber(number)
-  * isValidShortNumberForRegion(number, regionDialingFrom)
+* PhoneNumberFormat ( Enums is used to pass to [format(number, numberFormat)](#-formatnumber-numberformat) )
+  * E164 ( value is 0 )
+  * INTERNATIONAL ( value is 1 )
+  * NATIONAL ( value is 2 )
+  * RFC3966: ( value is 3 )
 
-* PhoneNumber
-  * [getCountryCode()](#-getcountrycode)
-  * [getCountryCodeSource()](#-getcountrycodesource)
-  * [getExtension()](#-getextension)
-  * [getItalianLeadingZero()](#-getitalianleadingzero)
-  * [getNationalNumber()](#-getnationalnumber)
-  * [getRawInput()](#-getrawinput)
-
-* PhoneNumberType
+* PhoneNumberType ( Enums is used to compare with the output of [getNumberType(number)](#-getnumbertypenumber ):
   * FIXED_LINE ( value is 0 )
@@ -59,15 +50,24 @@ * MOBILE ( value is 1 )
 
-* PhoneNumberFormat
-  * E164 ( value is 0 )
-  * INTERNATIONAL ( value is 1 )
-  * NATIONAL ( value is 2 )
-  * RFC3966: ( value is 3 )
+* PhoneNumber
+  * [getCountryCode()](#-getcountrycode)
+  * [getCountryCodeSource()](#-getcountrycodesource)
+  * [getExtension()](#-getextension)
+  * [getItalianLeadingZero()](#-getitalianleadingzero)
+  * [getNationalNumber()](#-getnationalnumber)
+  * [getRawInput()](#-getrawinput)
 
-* CountryCodeSource
-  * UNSPECIFIED ( value is 0)
-  * FROM_NUMBER_WITH_PLUS_SIGN ( value is 1)
-  * FROM_NUMBER_WITH_IDD ( value is 5)
-  * FROM_NUMBER_WITHOUT_PLUS_SIGN ( value is 10)
-  * FROM_DEFAULT_COUNTRY ( value is 20)
+* CountryCodeSource ( Enums in order to compare them with the output of [getCountryCodeSource()](#-getcountrycodesource) )
+  * UNSPECIFIED ( value is 0 )
+  * FROM_NUMBER_WITH_PLUS_SIGN ( value is 1 )
+  * FROM_NUMBER_WITH_IDD ( value is 5 )
+  * FROM_NUMBER_WITHOUT_PLUS_SIGN ( value is 10 )
+  * FROM_DEFAULT_COUNTRY ( value is 20 )
 
+* ShortNumberInfo
+  * [connectsToEmergencyNumber(number, regionCode)](#-connectstoemergencynumbernumber-regioncode) is used to checks whether the short number can be used to connect to emergency services when dialed from the given region.
+  * [isPossibleShortNumber(number)](#-ispossibleshortnumbernumber) is used to checks whether a short number is a possible number.
+  * [isPossibleShortNumberForRegion(number, regionDialingFrom)](#-ispossibleshortnumberforregionnumber-regiondialingfrom) is used to checks whether a short number is a possible number when dialed from the given region.
+  * isValidShortNumber(number) is used to checks whether a short number is a valid number.
+  * isValidShortNumberForRegion(number, regionDialingFrom) is used to checks whether a short number matches a valid pattern in a region.
+
 ## ❌ Missing Features:
@@ -431,94 +431,2 @@
 
-### 🎀 ShortNumberInfo
-
-#### 📦 connectsToEmergencyNumber(number, regionCode)
-
-Using Standard JavaScript:
-
-```js
-// Get an instance of ShortNumberInfo
-const shortInfo = require('libphonenumbers').ShortNumberInfo.getInstance();
-
-// Check 911 is emergency number in US
-console.log(shortInfo.connectsToEmergencyNumber('911', 'US'));
-// => true
-```
-
-Using ECMAScript (ES):
-
-```js
-import libphonenumbers from 'libphonenumbers';
-
-// Get an instance of ShortNumberInfo
-const shortInfo = libphonenumbers.ShortNumberInfo.getInstance();
-
-// Check 911 is emergency number in US
-console.log(shortInfo.connectsToEmergencyNumber('911', 'US'));
-// => true
-```
-
-#### 📦 isPossibleShortNumber(number)
-
-Using Standard JavaScript:
-
-```js
-// Get an instance of ShortNumberInfo
-const shortInfo = require('libphonenumbers').ShortNumberInfo.getInstance();
-
-// Get an instance of PhoneNumberUtil
-const phoneUtil = require('libphonenumbers').PhoneNumberUtil.getInstance();
-
-// Check 123456 is possible short number in FR
-console.log(shortInfo.isPossibleShortNumber(phoneUtil.parse('123456', 'FR')));
-// => true
-```
-
-Using ECMAScript (ES):
-
-```js
-import libphonenumbers from 'libphonenumbers';
-
-// Get an instance of ShortNumberInfo
-const shortInfo = libphonenumbers.ShortNumberInfo.getInstance();
-
-// Get an instance of PhoneNumberUtil
-const phoneUtil = libphonenumbers.PhoneNumberUtil.getInstance();
-
-// Check 123456 is possible short number in FR
-console.log(shortInfo.isPossibleShortNumber(phoneUtil.parse('123456', 'FR')));
-// => true
-```
-
-#### 📦 isPossibleShortNumberForRegion(number, regionDialingFrom)
-
-Using Standard JavaScript:
-
-```js
-// Get an instance of ShortNumberInfo
-const shortInfo = require('libphonenumbers').ShortNumberInfo.getInstance();
-
-// Get an instance of PhoneNumberUtil
-const phoneUtil = require('libphonenumbers').PhoneNumberUtil.getInstance();
-
-// Check 123456 is possible short number for region in FR
-console.log(shortInfo.isPossibleShortNumberForRegion(phoneUtil.parse('123456', 'FR'), 'FR'));
-// => true
-```
-
-Using ECMAScript (ES):
-
-```js
-import libphonenumbers from 'libphonenumbers';
-
-// Get an instance of ShortNumberInfo
-const shortInfo = libphonenumbers.ShortNumberInfo.getInstance();
-
-// Get an instance of PhoneNumberUtil
-const phoneUtil = libphonenumbers.PhoneNumberUtil.getInstance();
-
-// Check 123456 is possible short number for region in FR
-console.log(shortInfo.isPossibleShortNumberForRegion(phoneUtil.parse('123456', 'FR'), 'FR'));
-// => true
-```
-
 ### 🎀 PhoneNumber
@@ -718,2 +626,94 @@
 
+### 🎀 ShortNumberInfo
+
+#### 📦 connectsToEmergencyNumber(number, regionCode)
+
+Using Standard JavaScript:
+
+```js
+// Get an instance of ShortNumberInfo
+const shortInfo = require('libphonenumbers').ShortNumberInfo.getInstance();
+
+// Check 911 is emergency number in US
+console.log(shortInfo.connectsToEmergencyNumber('911', 'US'));
+// => true
+```
+
+Using ECMAScript (ES):
+
+```js
+import libphonenumbers from 'libphonenumbers';
+
+// Get an instance of ShortNumberInfo
+const shortInfo = libphonenumbers.ShortNumberInfo.getInstance();
+
+// Check 911 is emergency number in US
+console.log(shortInfo.connectsToEmergencyNumber('911', 'US'));
+// => true
+```
+
+#### 📦 isPossibleShortNumber(number)
+
+Using Standard JavaScript:
+
+```js
+// Get an instance of ShortNumberInfo
+const shortInfo = require('libphonenumbers').ShortNumberInfo.getInstance();
+
+// Get an instance of PhoneNumberUtil
+const phoneUtil = require('libphonenumbers').PhoneNumberUtil.getInstance();
+
+// Check 123456 is possible short number in FR
+console.log(shortInfo.isPossibleShortNumber(phoneUtil.parse('123456', 'FR')));
+// => true
+```
+
+Using ECMAScript (ES):
+
+```js
+import libphonenumbers from 'libphonenumbers';
+
+// Get an instance of ShortNumberInfo
+const shortInfo = libphonenumbers.ShortNumberInfo.getInstance();
+
+// Get an instance of PhoneNumberUtil
+const phoneUtil = libphonenumbers.PhoneNumberUtil.getInstance();
+
+// Check 123456 is possible short number in FR
+console.log(shortInfo.isPossibleShortNumber(phoneUtil.parse('123456', 'FR')));
+// => true
+```
+
+#### 📦 isPossibleShortNumberForRegion(number, regionDialingFrom)
+
+Using Standard JavaScript:
+
+```js
+// Get an instance of ShortNumberInfo
+const shortInfo = require('libphonenumbers').ShortNumberInfo.getInstance();
+
+// Get an instance of PhoneNumberUtil
+const phoneUtil = require('libphonenumbers').PhoneNumberUtil.getInstance();
+
+// Check 123456 is possible short number for region in FR
+console.log(shortInfo.isPossibleShortNumberForRegion(phoneUtil.parse('123456', 'FR'), 'FR'));
+// => true
+```
+
+Using ECMAScript (ES):
+
+```js
+import libphonenumbers from 'libphonenumbers';
+
+// Get an instance of ShortNumberInfo
+const shortInfo = libphonenumbers.ShortNumberInfo.getInstance();
+
+// Get an instance of PhoneNumberUtil
+const phoneUtil = libphonenumbers.PhoneNumberUtil.getInstance();
+
+// Check 123456 is possible short number for region in FR
+console.log(shortInfo.isPossibleShortNumberForRegion(phoneUtil.parse('123456', 'FR'), 'FR'));
+// => true
+```
+
 ## 🦄 Credit and Inspiration
@@ -720,0 +720,0 @@

No alert changes

Improved metrics

Total package byte prevSize

1155772

increased by0.12%

No dependency changes