8.10.5 • Published 5 years ago

libphonenumber-js-utils v8.10.5

Weekly downloads
20,029
License
MIT
Repository
-
Last release
5 years ago

Libphonenumber-js-utils · npm version Build Status

What is it?

This repo is a compiled and minified version of the utilities functions from the googlei18n's 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 :

NameTypeDescription
formatNumberFunctionFormat Phone number according to country
getExampleNumberFunctionGet example phonenumber of a country
getExtensionFunction
getNumberTypeFunctionGet the type of number entered like FIXED_LINE, MOBILE, etc.
getValidationErrorFunctionGet the validation error
isValidNumberFunctionCheck if a number is valid for a country
numberFormatEnumPossible Values: NATIONAL INTERNATIONAL
numberTypeEnumPossible Values: FIXED_LINE MOBILE FIXED_LINE_OR_MOBILE TOLL_FREE PREMIUM_RATE SHARED_COST VOIP PERSONAL_NUMBER PAGER UAN VOICEMAIL UNKNOWN
validationErrorEnumPossible Values: IS_POSSIBLE INVALID_COUNTRY_CODE TOO_SHORT TOO_LONG 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

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

Contributors :

@superhit0@patw0929@nutboltu