Skip to content

patw0929/libphonenumber-js-utils

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 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

Install maven and ant. For MacOS

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

Compile

sh scripts/execute.sh

Contributors

@superhit0 @patw0929 @nutboltu