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

Usage

const phone  = require('phone');

phone('[phone]'); // return ['[phone]', 'HKG']
phone('[phone]'); // return ['[phone], 'USA']
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('[phone]', ''); // return ['[phone]', 'USA']
phone('[phone]', ''); // return ['[phone]', 'USA']
phone('6123-6123', ''); // return [], as default country is USA
phone('6123-6123', 'HKG'); // return ['[phone]', 'HKG']

Test

npm 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?

   This package is used to validate a mobile phone number for sending the SMS.

   Therefore, we try to match all possible rules for specifically checking whether a number is mobile, such as area code, number prefix, etc.

   However, some countries, like the USA, don't have mobile identifiers, so we can only check if the input has a valid area code.

   For example, we know that UK mobile phone numbers always start with 7. In this case, phone can verify that the number is actually mobile.

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.