libphonenumber-js

[![NPM Version][npm-badge]][npm] [![Build Status][travis-badge]][travis] [![Test Coverage][coveralls-badge]][coveralls]

A simpler (and smaller) rewrite of Google Android's famous libphonenumber library.

LibPhoneNumber

libphonenumber is a phone number formatting and parsing library released by Google, originally developed for (and currently used in) Google's Android mobile phone operating system. Obviously, implementing a rigorous phone number formatting and parsing library was crucial for the phone OS overall usability (back then, in the early 2000s, it was originally meant to be a phone after all, not just a SnapChat device).

libphonenumber-js is a simplified javascript port of the original libphonenumber library (written in C++ and Java because those are the programming languages used in Android OS). While libphonenumber has an official javascript port which is being maintained by Google, it is tightly coupled to Google's closure javascript utility framework. It still can be compiled into one big bundle which weighs 220 KiloBytes — quite a size for a phone number input component. It can be customized too in a sense of which countries metadata to include but that wouldn't be an option for a worldwide solution.

One part of me was curious about how all this phone matching machinery worked, and another part of me was curious if there's a way to reduce those 220 KiloBytes to something more reasonable while also getting rid of the closure library and rewrite it all in pure javascript. So, that was my little hackathon for a couple of weeks, and seems that it succeeded. The resulting library does everything a modern web application needs while maintaining a much slimmer size of about 70 KiloBytes.

Difference from Google's libphonenumber

• Weighs less than 70 KiloBytes while libphonenumber bundle weighs about 220 KiloBytes
• When formatting international numbers replaces all braces, dashes, etc with spaces (because that's the logical thing to do, and leaving braces in an international number isn't)
• Doesn't parse alphabetic phone numbers like 1-800-GOT-MILK as we don't use telephone sets in the XXIst century that much (and we have phonebooks in your mobile phones)
• Doesn't handle carrier codes: they're only used in Colombia and Brazil, and only when dialing within those countries from a mobile phone to a fixed line number (the locals surely already know those carrier codes by themselves)
• Doesn't use possibleDigits data to speed up phone number pre-validation (it just skips to the regular expression check itself)
• Assumes all phone numbers being formatted are internationally diallable, because that's the only type of phone numbers users are supposed to be inputting on websites (no one inputs short codes, emergency telephone numbers like 911, etc.)
• Doesn't parse phone numbers with extensions (again, this is not the type of phone numbers users should input on websites — they're supposed to input their personal mobile phone numbers, or home stationary phone numbers if they're living in an area where celltowers don't have a good signal, not their business/enterprise stationary phone numbers)
• Doesn't distinguish between fixed line, mobile, pager, voicemail, toll free and other XXth century bullsh*t
• Doesn't format phone numbers for "out of country dialing", e.g. 011 ... in the US (again, just use the +... notation accepted worldwide for mobile phones)
• Doesn't parse tel:... URIs (RFC 3966) because it's not relevant for user-facing web experience

Installation

npm install libphonenumber-js --save

Usage

import { parse, format, asYouType } from 'libphonenumber-js'

parse('8 (800) 555 35 35', 'RU')
// { country: 'RU', phone: '8005553535' }

format('2133734253', 'US', 'International')
// '+1-213-373-4253'

new asYouType().input('+12133734')
// '+1 213 373 4'
new asYouType('US').input('2133734')
// '(213) 373-4'

API

parse(text, options)

options can be

country:
{
  restrict — (a two-letter country code)
             the phone number must be in this country

  default — (a two-letter country code)
            default country to use for phone number parsing and validation
            (if no country code could be derived from the phone number)
}

or just a two-letter country code which is gonna be country.restrict.

Returns { country, phone } where country is a two-letter country code, and phone is a national (significant) number. If the phone number supplied isn't valid for the corresponding country then an empty object is returned.

parse('+1-213-373-4253') === { country: 'US', phone: '2133734253' }
parse('(213) 373-4253', 'US') === { country: 'US', phone: '2133734253' }

format(parsed_number, format)

Formats an already parsed phone number in one of the following formats:

• International — e.g. +1 213 373 4253
• International_plaintext — (aka E.164) e.g. +12133734253
• National — e.g. (213) 373-4253

Can also be called with the first object argument expanded:

format('2133734253', 'US', 'International') === '+1-213-373-4253'
format({ country: 'US', phone: '2133734253' }, 'International') === '+1-213-373-4253'

isValidNumber(number, country_code)

(aka is_valid_number)

This function is simply a wrapper for parse: if parse returns an empty object then the phone number is not valid.

isValidNumber('+1-213-373-4253') === true
isValidNumber('+1-213-373') === false
isValidNumber('(213) 373-4253', 'US') === true
isValidNumber('(213) 37', 'US') === false

class asYouType(country_code)

(aka as_you_type)

Creates a formatter for partially entered phone number. The two-letter country_code is optional and if specified restricts the phone number being input to the specified country. The instance of this class has two methods:

• input(text) — takes any text and appends it to the input; returns the formatted phone number
• clear() — clears input

new asYouType().input('+12133734') === '+1 213 373 4'
new asYouType('US').input('2133734') === '(213) 373-4'

To do

• Implement "As you type"

Contributing

After cloning this repo, ensure dependencies are installed by running:

npm install

This module is written in ES6 and uses Babel for ES5 transpilation. Widely consumable JavaScript can be produced by running:

npm run build

Once npm run build has run, you may import or require() directly from node.

After developing, the full test suite can be evaluated by running:

npm test

When you're ready to test your new functionality on a real project, you can run

npm pack

It will build, test and then create a .tgz archive which you can then install in your project folder

npm install [module name with version].tar.gz

License

MIT [npm]: https://www.npmjs.org/package/libphonenumber-js [npm-badge]: https://img.shields.io/npm/v/libphonenumber-js.svg?style=flat-square [travis]: https://travis-ci.org/halt-hammerzeit/libphonenumber-js [travis-badge]: https://img.shields.io/travis/halt-hammerzeit/libphonenumber-js/master.svg?style=flat-square [coveralls]: https://coveralls.io/r/halt-hammerzeit/libphonenumber-js?branch=master [coveralls-badge]: https://img.shields.io/coveralls/halt-hammerzeit/libphonenumber-js/master.svg?style=flat-square