country-phonenumber

Country phone number parser

this library uses awesome-phonenumber and allows to get the country name after parsing the phone number.

Basic usage

import { phoneNumberParser } from 'country-phonenumber'

const pn = phoneNumberParser( '[phone]' );
pn.isValid( );  // -> true
pn.isMobile( ); // -> true
pn.canBeInternationallyDialled( ); // -> true
pn.getNumber( );                   // -> '[phone]'
pn.getNumber( 'e164' );            // -> '[phone]' (default)
pn.getNumber( 'international' );   // -> '[phone]'
pn.getNumber( 'national' );        // -> '6 99 99 99 99'
pn.getNumber( 'rfc3966' );         // -> 'tel:[phone]'
pn.getNumber( 'significant' );     // -> '699999999'
pn.getRegionCode( );               // -> 'CM'
pn.getCountryCode( );              // -> 237
pn.getRegionName( );               // -> Cameroon

pn.toJSON( );                  // -> json blob, so that:
JSON.stringify( pn, null, 4 ); // -> This:
// {
//     "canBeInternationallyDialled": true,
//     "number": {
//         "input": "0707123456",
//         "international": "[phone]",
//         "national": "070-712 34 56",
//         "e164": "[phone]",
//         "rfc3966": "tel:[phone]",
//         "significant": "707123456"
//     },
//     "regionCode": "SE",
//     "valid": true,
//     "possible": true,
//     "type": "mobile",
//     "possibility": "is-possible"
// }

The method getRegionName returns the country name.

Get object country name and phone prefix by country code

import { getCountryByCode } from "country-phonenumber";

console.log(getCountryByCode('FR')); 

// { name: "France", phone: 33 }

Get object country name and code by phone prefix

import { getCountryByPhone } from "country-phonenumber";

console.log(getCountryByPhone(237)); 

// { name: "Cameroon", code: "CM" }