phones

Parse, format, and validate US phone numbers

  • phones

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
phones
012.0.19 years ago9 years agoMinified + gzip package size for phones in KB

Readme

phones Build Status
Parse, format, and validate US phone numbers

Install

$ npm install --save phones

Usage

var phones = require('phones')

phones.parse('415-555-1234')
//=> 4155551234

phones.format('4155551234')
//=> 415 555 1234

phones.validate('4155551234')
//=> true

API

phones.parse(phone) -> string

phone
Required
Type: string
A phone number to parse. A leading 1 country code will be stripped.

phones.format(phone, [separator]) -> string

Format a 10 digit phone string by adding separators and truncating extra digits.
phone
Required
Type: string
A phone number to format. Digits only.
separator
Type: string
Default: '-'

phones.validate(phone) -> boolean

phone

Required
Type: string
A phone number to validate as a 10 digit string.

License

MIT © Ben Drucker