phone

What is phone?

The 'phone' npm package is a utility for parsing, validating, and formatting phone numbers. It helps in handling phone numbers in various formats and ensures they are in a consistent and usable format.

What are phone's main functionalities?

Parsing and Formatting Phone Numbers

This feature allows you to parse and format phone numbers into a standard E.164 format. The function returns an array where the first element is the formatted phone number and the second element is the country code.

const phone = require('phone');
const result = phone('[phone]');
console.log(result); // ['[phone]', 'USA']

Handling Different Country Codes

You can specify a country code to parse phone numbers according to the rules of that country. This is useful for handling international phone numbers.

const phone = require('phone');
const result = phone('1234567890', 'GB');
console.log(result); // ['[phone]', 'GB']

Validating Phone Numbers

The package can also be used to validate phone numbers. If the phone number is invalid, it returns an empty array.

const phone = require('phone');
const result = phone('1234567890', 'USA');
console.log(result); // []

Other packages similar to phone

libphonenumber-js

The 'libphonenumber-js' package is a more comprehensive library for parsing, formatting, and validating international phone numbers. It is based on Google's libphonenumber library and offers more extensive functionality and support for a wider range of phone number formats compared to 'phone'.

awesome-phonenumber

The 'awesome-phonenumber' package provides similar functionality to 'phone' but with additional features such as the ability to get the type of phone number (e.g., mobile, landline) and more detailed validation. It also supports more advanced formatting options.

README

Phone ·

What is phone?

phone is used to normalize mobile phone numbers into E.164 format.

A common problem is that users normally input phone numbers in this way:

`[phone]` or
`817569-8900` or
`1(817) 569-8900` or
`[phone]` or ...

We always want:

[phone]

Install

npm install phone

or

yarn add phone

Demo

Try it on CodeSandbox

Usage

const phone = require('phone');

phone('[phone]'); // return ['[phone]', 'HKG']
phone('[phone]', ''); // return ['[phone]', 'USA']
phone('[phone]', 'USA'); // return ['[phone]', 'USA']
phone('[phone]', 'HKG'); // return []
phone('[phone]', 'HKG'); // return [], as it is not a valid HKG mobile phone number
phone('6123-6123', 'HKG'); // return ['[phone]', 'HKG']

Without country code and no phone prefix

If both country code and country phone prefix are not provided, will treat as USA or Canada by default

phone('[phone]'); // return ['[phone], 'USA']
phone('[phone]', ''); // return ['[phone], 'USA']
phone('[phone]', ''); // return ['[phone]', 'USA']
phone('780-569-8900', ''); // return ['[phone], 'CAN'], 780 is a Canada phone prefix
phone('6123-6123', ''); // return [], as default country is USA / CAN and it does not match any result

Even you input a valid phone number with a valid prefix, if there is no plus sign, it will not work as expected:

phone('85291234567', '')

852 is a valid Hong Kong phone prefix, and 91234567 is a valid Hong Kong mobile phone number. However, there is no plus sign provided, the module will assume the phone number is a USA or Canada phone number, hence no result will be found.

If you know you have provided country phone prefix, make sure you also provide a plus sign:

phone('[phone]', '')

// return [ '[phone]', 'HKG' ]

or, if you know the country, and only want to reformat the phone number to E.164 format:

phone('91234567', 'HKG')

// return [ '[phone]', 'HKG' ]

Skipping phone number initial digit checking

If you want to skip phone number initial digit checking, set allowLandline to true:

phone('+(852) 2356-4902', '', true);

And the initial digit checking will be disabled completely, even you enter a phone number start with a non-exist digit:

phone('+(852) 0356-4902', '', true); // return [ '[phone]', 'HKG' ], even the phone number start with `0` is not a valid landline phone number

API

const phone = require('phone');

phone(phone: String, [country: string, allowLandline: Boolean]): Array

Input

Parameter	Type	Required	Description
phone	String	Yes	The phone number text you want to process
country	String	No	Provided country code in iso-3166 alpha 2 or 3 format
allowLandLine	Boolean	No	Set to true if you want to skip phone number initial digit checking

Returns

The return would always be an Array

Array index	Type	Description
0	String	Normalized phone number in E.164 format
1	String	Detected phone number country code in iso-3166 alpha 3 format

If the phone number cannot be reformatted due to any reason (e.g. unable to match any country), the result would be an empty array.

The function response is in Array format for some historical reason and expected to be updated to a proper object response in the next major version bump. (Will not change on version 2.x)

Test

yarn test

Build

yarn build

Old browsers & browser support

We currently transpile script to work on target environments for which the browser's global usage is >1%, and Node.js 6.10+.

You can check browser usage statistics on the browserlist.

You may need polyfills for some older browsers; for more details, please read the example/README file.

FAQ

1. Does phone do any logical validation?

   Yes. If you provide the 2nd parameter (country), and the phone number does not start with + sign.

   phone will validate phone_number_lengths and mobile_begin_with

2. Why is phone returning null for a valid phone number?

   By default, the function will validate a mobile phone number only, to validate a landline phone number, please set 3rd parameter allowLandline to true.

   If you find the result is still incorrect, please submit a ticket to improve our validation rules.

3. How does allowLandline work?

   Mobile phone number detection is achieved by comparing the beginning digits of a phone number to a list of possible mobile prefixes for a country. In some countries, some or all of these prefixes are the same for both mobile phones and landlines; when allowLandline is set to false you should not assume that all possible landline phone numbers will be reliably filtered out.

Help

We've tried to make sure that this package works for as many cases as possible, if you notice that we have an incorrect rule for a country or other case, please open an issue to let us know.

For creating new pull requests regarding add or modify phone number formats, please include the reference information such as PDFs, websites, etc. Thank you very much.

License

This project is licensed under the MIT license.