# libphonenumber-js-utils

> # What is it? This repo is a compiled and minified version of the utilities functions from the [googlei18n's libphonenumber](https://github.com/googlei18n/libphonenumber) library. The functions are exposed to `window.intlTelInputUtils` inside browser envi

Latest version **8.10.5** (published 2019-02-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install libphonenumber-js-utils
pnpm add libphonenumber-js-utils
yarn add libphonenumber-js-utils
bun add libphonenumber-js-utils
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 8.10.5 |
| Published | 2019-02-11 |
| First published | 2018-12-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 231.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | patw |

## Links

- npm: https://www.npmjs.com/package/libphonenumber-js-utils
- npm.io page: https://npm.io/package/libphonenumber-js-utils

## Recent versions

- 8.10.5 (latest) — 2019-02-11
- 8.10.4 — 2019-01-28
- 8.10.3-alpha.1 — 2019-01-13
- 8.10.3-alpha.0 — 2019-01-13
- 8.10.2 — 2019-01-03
- 8.9.9 — 2018-12-07

## README

# Libphonenumber-js-utils · [![npm version](https://badge.fury.io/js/libphonenumber-js-utils.svg)](https://www.npmjs.com/package/libphonenumber-js-utils) [![Build Status](https://travis-ci.org/patw0929/libphonenumber-js-utils.svg)](https://travis-ci.org/patw0929/libphonenumber-js-utils)

# What is it?
This repo is a compiled and minified version of the utilities functions from the [googlei18n's libphonenumber](https://github.com/googlei18n/libphonenumber) library.
The functions are exposed to `window.intlTelInputUtils` inside browser environment.

# How to use?
* Add `libphonenumber-js-utils` to the package dependency.
* `import 'libphonenumber-js-utils';` in your code.
* The functions will be available in `window.intlTelInputUtils`.

# Features inside it :
Name | Type | Description
-----|------|---------------
formatNumber | Function | Format Phone number according to country
getExampleNumber | Function | Get example phonenumber of a country
getExtension | Function | 
getNumberType | Function | Get the type of number entered like `FIXED_LINE`, `MOBILE`, etc.
getValidationError | Function | Get the validation error
isValidNumber | Function | Check if a number is valid for a country
numberFormat | Enum | **Possible Values:**<br>&bull; `NATIONAL` <br>&bull; `INTERNATIONAL`
numberType | Enum | **Possible Values:**<br>&bull; `FIXED_LINE` <br>&bull; `MOBILE` <br>&bull; `FIXED_LINE_OR_MOBILE` <br>&bull; `TOLL_FREE` <br>&bull; `PREMIUM_RATE` <br>&bull; `SHARED_COST` <br>&bull; `VOIP` <br>&bull; `PERSONAL_NUMBER` <br>&bull; `PAGER` <br>&bull; `UAN` <br>&bull; `VOICEMAIL` <br>&bull; `UNKNOWN`
validationError | Enum | **Possible Values:**<br>&bull; `IS_POSSIBLE` <br>&bull; `INVALID_COUNTRY_CODE` <br>&bull; `TOO_SHORT` <br>&bull; `TOO_LONG` <br>&bull; `NOT_A_NUMBER`

# How to build it?
### Setup :
Checkout closure-library, closure-compiler, closure-linter and python-gflags next to libphonenumber:

* `git clone https://github.com/googlei18n/libphonenumber/`

* `git clone https://github.com/google/closure-library/`

* `git clone https://github.com/google/closure-compiler.git`

* `git clone https://github.com/google/closure-linter.git`

* `git clone https://github.com/google/python-gflags.git`

### Compile :
1. Build Closure's compiler.jar:
  `mvn -DskipTests`
2. Copy the contents of 
`src/libphonenumber.js` to `libphonenumber/javascript/i18n/phonenumbers/demo.js`.

3. Compile the demo.js and all its dependencies to one file: `demo-compiled.js`:
  `ant -f javascript/build.xml compile-demo`

3. Run the compiled demo: `javascript/i18n/phonenumbers/demo-compiled.html`

# Contributors :
[![@superhit0](https://avatars.githubusercontent.com/superhit0?size=50)](https://github.com/superhit0) | [![@patw0929](https://avatars.githubusercontent.com/patw0929?size=50)](https://github.com/patw0929) | [![@nutboltu](https://avatars.githubusercontent.com/nutboltu?size=50)](https://github.com/nutboltu)
----|-----|-----

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