Skip to content

reaphq/libphonenumber-js-utils

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

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:
NATIONAL
INTERNATIONAL
numberType Enum Possible Values:
FIXED_LINE
MOBILE
UNKNOWN
validationError Enum Possible Values:
IS_POSSIBLE
INVALID_COUNTRY_CODE
TOO_SHORT
TOO_LONG
NOT_A_NUMBER

How to build it

Install Dependencies & Compile

Install maven and ant. For MacOS

brew install ant
brew install maven
sh scripts/build-dependencies.sh
sh scripts/execute.sh

Updating underlying google libphonenumber library

  1. Bump googleLibphonenumberVersion in package.json to updated version.
  2. Build dependencies with sh scripts/build-dependencies.sh
  3. Delete <arg line="--jscomp_error=undefinedNames" /> flag in libphonenumber/javascript/build.xml to allow the execution script to succeed.
  4. Convert the built libphonenumber/javascript/i18n/phonenumbers/compile-demo.js from ecmascript2020 to es5 (https://jstool.gitlab.io/babel-es6-to-es5/)
  5. Delete the "@babel/helpers - typeof" text in the generated code.
  6. Run the execute script sh scripts/execute.sh
  7. Check that the dist/libphonenumber.js is generated successfully.
  8. Push code.

Contributors

@superhit0 @patw0929 @nutboltu

Updating google libphonenumber lib

  1. Bump googleLibphonenumberVersion in package.json to whichever version is necessary.
  2. Rerun instructons above to build dependencies and compile.
  3. Push changes

About

Dependency of react-intl-tel-input

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 89.1%
  • Shell 10.9%