-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #14 from patw0929/feature-filter-metadata
feat(filter-metadata): Filtered google lib metadata
- Loading branch information
Showing
11 changed files
with
2,419 additions
and
1,260 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,52 +1,52 @@ | ||
# 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? | ||
## 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? | ||
## 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 : | ||
## Features inside it | ||
|
||
Name | Type | Description | ||
-----|------|--------------- | ||
formatNumber | Function | Format Phone number according to country | ||
getExampleNumber | Function | Get example phonenumber of a country | ||
getExtension | Function | | ||
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>• `NATIONAL` <br>• `INTERNATIONAL` | ||
numberType | Enum | **Possible Values:**<br>• `FIXED_LINE` <br>• `MOBILE` <br>• `FIXED_LINE_OR_MOBILE` <br>• `TOLL_FREE` <br>• `PREMIUM_RATE` <br>• `SHARED_COST` <br>• `VOIP` <br>• `PERSONAL_NUMBER` <br>• `PAGER` <br>• `UAN` <br>• `VOICEMAIL` <br>• `UNKNOWN` | ||
numberType | Enum | **Possible Values:**<br>• `FIXED_LINE` <br>• `MOBILE` <br>• `UNKNOWN` | ||
validationError | Enum | **Possible Values:**<br>• `IS_POSSIBLE` <br>• `INVALID_COUNTRY_CODE` <br>• `TOO_SHORT` <br>• `TOO_LONG` <br>• `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/` | ||
## How to build it | ||
|
||
* `git clone https://github.com/google/closure-library/` | ||
### Install Dependencies | ||
|
||
* `git clone https://github.com/google/closure-compiler.git` | ||
Install `maven` and `ant`. For MacOS | ||
|
||
* `git clone https://github.com/google/closure-linter.git` | ||
```sh | ||
brew install ant | ||
brew install maven | ||
``` | ||
|
||
* `git clone https://github.com/google/python-gflags.git` | ||
```sh | ||
sh scripts/build-dependencies.sh | ||
``` | ||
|
||
### Compile : | ||
1. Build Closure's compiler.jar: | ||
`mvn -DskipTests` | ||
2. Copy the contents of | ||
`src/libphonenumber.js` to `libphonenumber/javascript/i18n/phonenumbers/demo.js`. | ||
### Compile | ||
|
||
3. Compile the demo.js and all its dependencies to one file: `demo-compiled.js`: | ||
`ant -f javascript/build.xml compile-demo` | ||
```sh | ||
sh scripts/execute.sh | ||
``` | ||
|
||
3. Run the compiled demo: `javascript/i18n/phonenumbers/demo-compiled.html` | ||
## Contributors | ||
|
||
# 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) | ||
----|-----|----- |
Oops, something went wrong.