Added normalize function
- This function strips out special characters and trims the phone number, much like uglify but skips non-digit characters
- Example: normalize('555.444.3333 x 123') // => '5554443333x123' vs uglify('555.444.3333 x 123') // => 5554443333123
Added validate function
- This is a validation function, but works better for world wide phone numbers as well. Expects the full number
- Example: 333-444-5555 comes back valid but 444-5555 is invalid to this function
Added isValidWithFormat function
- This takes a string phone number and a format string and validates the phone using the format
- It's also passed through the validate function for an extra step of validation
Added findSeparators function
- A simple function that finds the separators in a phone number and returns them as an array
Added breakdownWithFormat function
- Works a lot like breakdown but follows a strict format provided by the user to breakdown the number into an object
- This allows for a wider range of phone number support for breakdown

Phone-fns is no longer dependant on Kyanite and is dependency free!
isValid description to explain that it mostly focused on NANP numbers
breakdown description to better explain that it's main focus is NANP numbers and its gachas
We more than doubled our unit tests! Woo!

4.0.2

published 4.0.2 • last month

Changelog

4.0.1

published 4.0.1 • 10 months ago

Changelog

Added warning into README that currently phone-fns is focused on US based phone number styles
Updated github action to LTS of node

published 4.0.0 • last year

Changelog

Converted Phone-Fns to a standard ESM module
- This means if you are using import statements in an ESM module for phone-fns this changes:
  - import phoneFns from 'phone-fns' --> import * as phoneFns from 'phone-fns'
  - You can also just destructure from here still like so: import { isValid } from 'phone-fns'
- Phone fns should still support common js syntax out of the box as well
Upgraded to Kyanite v2.0.1