# phone-prettify

> Silly simple phone formatting library

Latest version **1.5.1** (published 2017-10-28) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install phone-prettify
pnpm add phone-prettify
yarn add phone-prettify
bun add phone-prettify
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.5.1 |
| Published | 2017-10-28 |
| First published | 2016-05-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Dustin Hershman |
| Maintainers | killparadise |
| Keywords | format, phone number, prettyify, phone, phone-prettify, phone formatting, formatting |

## Links

- npm: https://www.npmjs.com/package/phone-prettify
- Repository: https://github.com/dhershman1/phone-prettify
- Homepage: https://github.com/dhershman1/phone-prettify#readme
- Issues: https://github.com/dhershman1/phone-prettify/issues
- npm.io page: https://npm.io/package/phone-prettify

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.5.1 (latest) — 2017-10-28
- 1.5.0 — 2017-10-05
- 1.4.0 — 2017-07-10
- 1.3.0 — 2017-06-16
- 1.2.3 — 2017-05-30
- 1.2.2 — 2017-05-24
- 1.2.0 — 2017-05-01
- 1.1.2 — 2017-04-06
- 1.1.1 — 2017-02-02
- 1.1.0 — 2017-02-02
- 1.0.4 — 2017-01-30
- 1.0.3 — 2016-08-26
- 1.0.2 — 2016-05-18
- 1.0.1 — 2016-05-18
- 1.0.0 — 2016-05-18

## README

[![Build Status](https://travis-ci.org/dhershman1/phone-prettify.svg?branch=master)](https://travis-ci.org/dhershman1/phone-prettify)

# phone-prettify

A simple and light weight phone formatting utility that can handle most (US) formats, basic extension and long distance style phone numbers.

## How-To

Standard module system

```js
import {uglify, dashed, dotted, normalize, longDistance, extensionNumber} from 'phone-prettify';
// Now you can use each as a function
dashed(phone);
dotted(phone2);
```

Common JS

```js
pPretty = require('phone-prettify');
pPretty.dashed(phone);
```

Through the browser

```js
<script src="path/to/location/dist/phone-prettify.umd.js"></script>
phonePrettify.dashed(phone);
```

## Formats
Each format can convert from each other. for example you can send `dotted` a `dashed` format number and get the `dotted` format back.

- `uglify` - Returns string of entered phone with no formatting
- `groupTwo` - Groups 8 or 10 character numbers to a `XX XX XX XX` or `XX XX XX XX XX` format
- `groupFour` - Groups 8 or 10 character numbers to a `XXXX XXXX` or `XX XXXX XXXX` format
- `normalize` - Returns phone number with `(xxx)xxx-xxxx` format
- `dashed`  - Returns phone number with `xxx-xxx-xxxx` format
- `dotted` - Returns phone number with `xxx.xxx.xxxx` format
- `longDistance` - Returns phone number with `x+xxx-xxx-xxxx` format take an optional param to format with different styles
- `extensionNumber` - Returns phone number with `XXX-XXX-XXXX x XXXX` format takes an optional param to format with different styles

## Return

Each method returns the formatted version of the string passed in. If an improper phone number or a falsey value are passed in, the method will simply return back that value

```js
import { normalize } from 'phone-prettyify';

console.log(normalize('88551'));
// Output: '88551'
```

## Methods

### uglify(phone)

`uglifies` the phone number down to just the number string

#### Arguments

- `phone` - `String`: the desired phone number to run against

#### Usage

```js
import {uglify} from 'phone-prettify';

console.log(uglify('555-444-1111'));
// Output: 5554441111
```

### groupTwo(phone)

Groups the number into four or five groups of two

#### Arguments

- `phone` - `String`: the desired phone number to run against

#### Usage

```js
import {groupTwo} from 'phone-prettify';

console.log(groupTwo('44332211'));
// Output: 44 33 22 11
// Also supports 10 character numbers
console.log(groupTwo('5544332211'));
// Output: 55 44 33 22 11
```

### groupFour(phone)

Groups the number into two groups of four, or into one group of two and two groups of four

#### Arguments

- `phone` - `String`: the desired phone number to run against

#### Usage

```js
import {groupFour} from 'phone-prettify';

console.log(groupFour('44332211'));
// Output: 4433 2211
// Also supports 10 character numbers
console.log(groupFour('5544332211'));
// Output: 55 4433 2211
```

### normalize(phone)

`normalizes` the phone number format (see [Formats](#formats))

#### Arguments

- `phone` - `String`: the desired phone number to run against

#### Usage

```js
import {normalize} from 'phone-prettify';

console.log(normalize('5554441111'));
// Output: (555) 444-1111
```

### dashed(phone)

convert the phone number to `dashed` format (see [Formats](#formats))

#### Arguments

- `phone` - `String`: the desired phone number to run against

#### Usage

```js
import {dashed} from 'phone-prettify';

console.log(dashed('5554441111'));
// Output: 555-444-1111
```

### dotted(phone)

convert the phone number to `dotted` format (see [Formats](#formats))

#### Arguments

- `phone` - `String`: the desired phone number to run against

#### Usage

```js
import {dotted} from 'phone-prettify';

console.log(dotted('5554441111'));
// Output: 555.444.1111
```

### longDistance(phone, format)

convert the phone number to `longDistance` format (see [Formats](#formats))

#### Arguments

- `phone` - `String`: the desired phone number to run against
- `format` - `String`: the format you'd like the outcome to be in `Default: dashed`

#### Usage

```js
import {longDistance} from 'phone-prettify';

console.log(longDistance('15554441111', 'dotted'));
// Output: 1+555.444.1111
```

### extensionNumber(phone, format)

convert the phone number to `extensionNumber` format (see [Formats](#formats))

#### Arguments

- `phone` - `String`: the desired phone number to run against
- `format` - `String`: the format you'd like the outcome to be in `Default: dashed`

#### Usage

```js
import {extensionNumber} from 'phone-prettify';

console.log(extensionNumber('55544411118989', 'dotted'));
// Output: 555.444.1111 x 8989
```

---
_Source: https://npm.io/package/phone-prettify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._