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

What is node-phone?

node-phone is used to normalize the phone number into a E.164 format.

The common problem is user normally input the phone number in this way:

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

What we want is always:

[phone]

##FAQ

1. Does node-phone do any phone validation?

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

   phone will validate phone_number_lengths and validation_begin_with

   No: If the phone number start with + sign, even you pass the country. phone will simply remove all non digit and return +XXXXXXXX to you.

2. Why do you make this?

   Because we need to normalize the phone number for SMS notification for mobile phone only.

We don't validate if the number is mobile or not.

Install

npm install phone

Usage

var phone = require('phone`);

phone('[phone]', ''); // return [phone]
phone('[phone]', 'USA'); // return [phone]
phone('[phone]', 'HKG'); // return null
phone('[phone]', HKG); // return [phone]
phone('[phone]', ''); // return [phone]
phone('6123-6123', ''); // return null, as default country is USA
phone('6123-6123', 'HKG'); // return [phone]

License

MIT