Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
awesome-phonenumber
Advanced tools
The awesome-phonenumber npm package is a comprehensive library for parsing, formatting, and validating phone numbers. It supports a wide range of international phone number formats and provides utilities for handling phone number data effectively.
Parsing Phone Numbers
This feature allows you to parse a phone number from a string and create a PhoneNumber object. The example demonstrates how to parse a US phone number.
const PhoneNumber = require('awesome-phonenumber');
const pn = new PhoneNumber('+12025550123');
console.log(pn.getNumber()); // Outputs: +12025550123
Formatting Phone Numbers
This feature allows you to format phone numbers in different formats such as E.164, international, and national. The example shows how to format a US phone number in various formats.
const PhoneNumber = require('awesome-phonenumber');
const pn = new PhoneNumber('+12025550123');
console.log(pn.getNumber('e164')); // Outputs: +12025550123
console.log(pn.getNumber('international')); // Outputs: +1 202-555-0123
console.log(pn.getNumber('national')); // Outputs: (202) 555-0123
Validating Phone Numbers
This feature allows you to validate whether a phone number is valid or not. The example demonstrates how to check the validity of a US phone number.
const PhoneNumber = require('awesome-phonenumber');
const pn = new PhoneNumber('+12025550123');
console.log(pn.isValid()); // Outputs: true
Getting Region Code
This feature allows you to get the region code of a phone number. The example shows how to retrieve the region code for a US phone number.
const PhoneNumber = require('awesome-phonenumber');
const pn = new PhoneNumber('+12025550123');
console.log(pn.getRegionCode()); // Outputs: US
Getting Country Code
This feature allows you to get the country code of a phone number. The example demonstrates how to retrieve the country code for a US phone number.
const PhoneNumber = require('awesome-phonenumber');
const pn = new PhoneNumber('+12025550123');
console.log(pn.getCountryCode()); // Outputs: 1
libphonenumber-js is a simpler and smaller alternative to Google's libphonenumber library. It provides similar functionalities for parsing, formatting, and validating phone numbers. Compared to awesome-phonenumber, libphonenumber-js is more lightweight and may be preferable for projects where bundle size is a concern.
google-libphonenumber is a comprehensive library developed by Google for parsing, formatting, and validating international phone numbers. It is the most feature-rich and widely used library for phone number handling. Compared to awesome-phonenumber, google-libphonenumber offers more extensive support and features but comes with a larger bundle size.
The phone package is a simple library for parsing and formatting phone numbers. It is less feature-rich compared to awesome-phonenumber but provides basic functionalities for handling phone numbers. It is suitable for projects that require minimal phone number processing capabilities.
This library is a pre-compiled version of Google's libphonenumber
, with a slightly simpler interface. It has a minimal footprint - is by far the smallest libphonenumber-based library available on npmjs, and has no dependencies.
TypeScript typings are provided within the package.
Uses libphonenumber v8.12.8
Since this library is pre-compiled, it doesn't depend on the closure compiler, and needs not load it on start. This makes the library faster and saves you a lot of space. It also means this library is trivial to use in any browserify
project (or using any other means to run in the browser).
Among all the phone number libraries using Google's libphonenumber
, only this one, google-libphonenumber
(2.0.0) and node-phonenumber
(0.2.2) had decent README's with examples. Other libraries embedding the closure compiler should get comparable figures.
Loading the closure compiler also adds to the application memory usage (RSS is measured here). The library footprints are also bigger, making npm install
slower and increasing deploy times.
A test program loading a library, then parsing a phone number is called 100 times for each library, the mean values are:
Action | awesome-phonenumber (7.5.2) | google-libphonenumber (7.6.1) | node-phonenumber (7.5.2) |
---|---|---|---|
Load library first time | 20.84 ms | 60.99ms | 99.27 ms |
Parse first phone number | 5.79 ms | 6.51 ms | 8.15 ms |
Parse second phone number | 0.33 ms | 0.67 ms | 0.80 ms |
Increased memory usage | 7.3 M | 13.8 M | 22.5 M |
node_modules size | 248 K | 436 K | 57 M |
node_modules files | 7 | 7 | 4525 |
time npm install | 667 ms | 700 ms | 4077 ms |
var PhoneNumber = require( 'awesome-phonenumber' );
var pn = new PhoneNumber( '0707123456', 'SE' );
pn.isValid( ); // -> true
pn.isMobile( ); // -> true
pn.canBeInternationallyDialled( ); // -> true
pn.getNumber( ); // -> '+46707123456'
pn.getNumber( 'e164' ); // -> '+46707123456' (default)
pn.getNumber( 'international' ); // -> '+46 70 712 34 56'
pn.getNumber( 'national' ); // -> '070-712 34 56'
pn.getNumber( 'rfc3966' ); // -> 'tel:+46-70-712-34-56'
pn.getNumber( 'significant' ); // -> '707123456'
pn.getRegionCode( ); // -> 'SE'
pn.getCountryCode( ); // -> 46
pn.toJSON( ); // -> json blob, so that:
JSON.stringify( pn, null, 4 ); // -> This:
// {
// "canBeInternationallyDialled": true,
// "number": {
// "input": "0707123456",
// "international": "+46 70 712 34 56",
// "national": "070-712 34 56",
// "e164": "+46707123456",
// "rfc3966": "tel:+46-70-712-34-56",
// "significant": "707123456"
// },
// "regionCode": "SE",
// "valid": true,
// "possible": true,
// "type": "mobile",
// "possibility": "is-possible"
// }
When constructed with a phone number on e164
format (i.e. prefixed with a +
), awesome-phonenumber will auto-detect the country:
PhoneNumber( '+46707123456' ).getRegionCode( ); // -> 'SE'
The API consists of the PhoneNumber
class which sometimes uses enums. These are:
'fixed-line'
'fixed-line-or-mobile'
'mobile'
'pager'
'personal-number'
'premium-rate'
'shared-cost'
'toll-free'
'uan'
'voip'
'unknown'
'is-possible'
'invalid-country-code'
'too-long'
'too-short'
'unknown'
'international'
'national'
'e164'
'rfc3966'
'significant'
var PhoneNumber = require( 'awesome-phonenumber' );
There are conversion functions between the 2-character ISO 3166-1 region codes (e.g. 'SE' for Sweden) and the corresponding country calling codes.
PhoneNumber.getCountryCodeForRegionCode( regionCode ); // -> countryCode
PhoneNumber.getRegionCodeForCountryCode( countryCode ); // -> regionCode
PhoneNumber.getCountryCodeForRegionCode( 'SE' ); // -> 46
PhoneNumber.getRegionCodeForCountryCode( 46 ); // -> 'SE'
PhoneNumber.getSupportedCallingCodes( ); // -> [ calling codes... ]
PhoneNumber.getSupportedRegionCodes( ); // -> [ region codes... ]
An instance of the PhoneNumber
class will be created even if PhoneNumber
is called as a function.
var pn = PhoneNumber( number, regionCode );
// is the same as
var pn = new PhoneNumber( number, regionCode );
PhoneNumber objects can also be created using the getExample( regionCode[, type ] )
function, see section Example phone numbers for country below.
pn.toJSON( ); // -> json blob as seen in "Basic usage" above
pn.isValid( ); // -> Boolean
pn.isPossible( ); // -> Boolean
pn.getType( ); // -> Any of the "Phone number types" defined above
pn.isMobile( ); // -> true if type is 'mobile' or 'fixed-line-or-mobile'
pn.isFixedLine( ); // -> true if type is 'fixed-line' or 'fixed-line-or-mobile'
pn.getNumber( [ format ] ); // -> Formatted number, see "Basic usage" for examples
// Returns the number formatted to how to dial it from another region.
pn.getNumberFrom( fromRegionCode );
// Calling the Swedish number 0707123456 from Japan:
PhoneNumber( '0707123456', 'SE' ).getNumberFrom( 'JP' ); // '010 46 70 712 34 56'
Sometimes you want to display a formatted example phone number for a certain country (and maybe also a certain type of phone number). The getExample
function is used for this.
PhoneNumber.getExample( regionCode[, phoneNumberType] ); // PhoneNumber object
The phoneNumberType
is any of the types defined above.
PhoneNumber.getExample( 'SE' ).getNumber( ); // '+468123456'
PhoneNumber.getExample( 'SE', 'mobile' ).getNumber( ); // '+46701234567'
PhoneNumber.getExample( 'SE', 'mobile' ).getNumber( 'national' ); // '070 123 45 67'
You can use an AsYouType
class to format a phone number as it is being typed. An instance of this class is retrieved by var ayt = PhoneNumber.getAsYouType( regionCode )
, and has the following methods:
// Add a character to the end of the number
ayt.addChar( nextChar );
// Get the current formatted number
ayt.number( );
// Remove the last character
ayt.removeChar( );
// Replace the whole number with a new number (or an empty number if null)
ayt.reset( [ number ] );
// Get a PhoneNumber object representing the current number
ayt.getPhoneNumber( );
All the functions above except getPhoneNumber( )
return the current formatted number (as a String of course, as it may include spaces and other characters).
var ayt = PhoneNumber.getAsYouType( 'SE' );
ayt.addChar( '0' ); // -> '0'
ayt.addChar( '7' ); // -> '07'
ayt.addChar( '0' ); // -> '070'
ayt.addChar( '7' ); // -> '070 7'
ayt.addChar( '1' ); // -> '070 71'
ayt.addChar( '2' ); // -> '070 712'
ayt.addChar( '3' ); // -> '070 712 3'
ayt.addChar( '4' ); // -> '070 712 34'
ayt.addChar( '5' ); // -> '070 712 34 5'
ayt.addChar( '6' ); // -> '070 712 34 56'
ayt.removeChar( ); // -> '070 712 34 5'
ayt.addChar( '7' ); // -> '070 712 34 57'
FAQs
Google's libphonenumber pre-compiled with the closure compiler
The npm package awesome-phonenumber receives a total of 395,111 weekly downloads. As such, awesome-phonenumber popularity was classified as popular.
We found that awesome-phonenumber demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.