Morioh
Login
Alex Lambert

Alex Lambert

3 years ago

Validating international phone numbers in Node.js

libphonenumbers

libphonenumbers

libphonenumbers is JS port of Google’s libphonenumber.

libphonenumbers – JavaScript port of Google’s libphonenumber library for parsing, formatting, and validating international phone numbers in Node.js.

🎁 Features

libphonenumbers is compatible with both JavaScript and TypeScript.

  • PhoneNumberUtil

  • ShortNumberInfo

    • connectsToEmergencyNumber(number, regionCode)
    • isPossibleShortNumberForRegion(number, regionDialingFrom)
    • isValidShortNumber(number)
    • isPossibleShortNumber(number)
    • isValidShortNumberForRegion(number, regionDialingFrom)

  • PhoneNumber

    • getCountryCode()
    • getCountryCodeSource()
    • getExtension()
    • getItalianLeadingZero()
    • getNationalNumber()
    • getRawInput()

  • PhoneNumberType

    • FIXED_LINE ( value: 0 )
    • MOBILE ( value: 1 )
    • FIXED_LINE_OR_MOBILE ( value: 2 )
    • TOLL_FREE ( value: 3 )
    • PREMIUM_RATE ( value: 4 )
    • SHARED_COST ( value: 5 )
    • VOIP ( value: 6 )
    • PERSONAL_NUMBER ( value: 7 )
    • PAGER ( value: 8 )
    • UAN ( value: 8 )
    • VOICEMAIL ( value: 10 )
    • UNKNOWN ( value: -1 )

  • PhoneNumberFormat

    • E164 ( value: 0 )
    • INTERNATIONAL ( value: 1 )
    • NATIONAL ( value: 2 )
    • RFC3966: ( value: 3 )

  • CountryCodeSource

    • UNSPECIFIED ( value: 0)
    • FROM_NUMBER_WITH_PLUS_SIGN ( value: 1)
    • FROM_NUMBER_WITH_IDD ( value: 5)
    • FROM_NUMBER_WITHOUT_PLUS_SIGN ( value: 10)
    • FROM_DEFAULT_COUNTRY ( value: 20)

❌ Missing Features:

JS port of Google’s libphonenumber does not support the following functions and classes:

  • findNumbers
  • PhoneNumberOfflineGeocoder
  • PhoneNumberToTimeZonesMapper
  • PhoneNumberToCarrierMapper

🔧 Install

libphonenumbers is available on npm. It can be installed with the following command:

npm install libphonenumbers --save

libphonenumbers is available on yarn as well. It can be installed with the following command:

yarn add libphonenumbers

💡 Usage

🎀 PhoneNumberUtil

format(number, numberFormat)

Using Standard JavaScript:

const PNF = require('libphonenumbers').PhoneNumberFormat;
// Create an instance of PhoneNumberUtil
const phoneUtil = require('libphonenumbers').PhoneNumberUtil.getInstance(); 

// Parse number with US country code and keep raw input
const number = phoneUtil.parseAndKeepRawInput('300-577-8989', 'US');

// Format number in the RFC3966 format
console.log(phoneUtil.format(number, PNF.RFC3966));
// => tel:+1-300-577-8989

// Format number in the national format
console.log(phoneUtil.format(number, PNF.NATIONAL));
// => (300) 577-8989

// Format number in the international format
console.log(phoneUtil.format(number, PNF.INTERNATIONAL));
// => +1 300-577-8989

Using ECMAScript (ES):

import libphonenumbers from 'libphonenumbers';

const PNF = libphonenumbers.PhoneNumberFormat;

// Create an instance of PhoneNumberUtil
const phoneUtil = libphonenumbers.PhoneNumberUtil.getInstance();

// Parse number with US country code and keep raw input
const number = phoneUtil.parseAndKeepRawInput('300-577-8989', 'US');

// Format number in the RFC3966 format
console.log(phoneUtil.format(number, PNF.RFC3966));
// => tel:+1-300-577-8989

// Format number in the national format
console.log(phoneUtil.format(number, PNF.NATIONAL));
// => (300) 577-8989

// Format number in the international format
console.log(phoneUtil.format(number, PNF.INTERNATIONAL));
// => +1 300-577-8989
formatInOriginalFormat(number, regionCallingFrom)

Using Standard JavaScript:

// Create an instance of PhoneNumberUtil
const phoneUtil = require('libphonenumbers').PhoneNumberUtil.getInstance();

// Parse number with US country code and keep raw input
const number = phoneUtil.parseAndKeepRawInput('300-577-8989', 'US');

// Format number in the original format
console.log(phoneUtil.formatInOriginalFormat(number, 'US'));
// => (300) 577-8989

Using ECMAScript (ES):

import libphonenumbers from 'libphonenumbers';

// Create an instance of PhoneNumberUtil
const phoneUtil = libphonenumbers.PhoneNumberUtil.getInstance();

// Parse number with US country code and keep raw input
const number = phoneUtil.parseAndKeepRawInput('300-577-8989', 'US');

// Format number in the original format
console.log(phoneUtil.formatInOriginalFormat(number, 'US'));
// => (300) 577-8989
formatOutOfCountryCallingNumber(number, regionCallingFrom)

Using Standard JavaScript:

// Create an instance of PhoneNumberUtil
const phoneUtil = require('libphonenumbers').PhoneNumberUtil.getInstance();

// Parse number with US country code and keep raw input
const number = phoneUtil.parseAndKeepRawInput('300-577-8989', 'US');

// Format number in the out-of-country format from US
console.log(phoneUtil.formatOutOfCountryCallingNumber(number, 'US'));
// => 1 (300) 577-8989

// Format number in the out-of-country format from JP
console.log(phoneUtil.formatOutOfCountryCallingNumber(number, 'JP'));
// => 010 1 300-577-8989

Using ECMAScript (ES):

import libphonenumbers from 'libphonenumbers';

// Create an instance of PhoneNumberUtil
const phoneUtil = libphonenumbers.PhoneNumberUtil.getInstance();

// Parse number with US country code and keep raw input
const number = phoneUtil.parseAndKeepRawInput('300-577-8989', 'US');

// Format number in the out-of-country format from US
console.log(phoneUtil.formatOutOfCountryCallingNumber(number, 'US'));
// => 1 (300) 577-8989

// Format number in the out-of-country format from JP
console.log(phoneUtil.formatOutOfCountryCallingNumber(number, 'JP'));
// => 010 1 300-577-8989

🦄 Credit and Inspiration

Inspired by Google’s libphonenumber.

Download Details:

Author: Bunlong

Source Code: https://github.com/Bunlong/libphonenumbers

#node #nodejs #javascript

Validating international phone numbers in Node.js
17.30 GEEK