@telefonica/libphonenumber/README.md

libphonenumber wrapper

# libphonenumber js wrapper

Wrapper around a custom compilation of [Google's libphonenumber](https://github.com/google/libphonenumber).

- Compiled using ADVANCED_OPTIMIZATIONS to obtain the smallest possible library
- Only the needed features should be exposed. This way the compiler can effectively remove unused code

## API

```ts
formatAsYouType(number: string, viewerRegionCode: string): string;
formatToE164(phone: PhoneNumber): string;
formatToInternational(phone: PhoneNumber): string;
formatToNational(phone: PhoneNumber): string;
formatToNationalNumberWithCarrierCode(phoneNumber: PhoneNumber, carrierCode: string): string;
formatToPrint(phone: PhoneNumber, viewerRegionCode: string): string;
getPhoneNumberType(number: string, regionCode: string): string;
getRegionCodeForNumber(number: string, defaultRegionCode: string): string;
getRegionCodeForCountryCode(countryCode: string): string;
getPhoneDestinationTypeForNumber(number: string, defaultRegionCode: string): string;
isMobile(phone: PhoneNumber): boolean;
isMobileOrFixedLine(phone: PhoneNumber): boolean;
isShort(phone: PhoneNumber): boolean;
isValidNumber(phone: PhoneNumber): boolean;
parse(number: string, regionCode: string): PhoneNumber;
```

## Install

```bash
yarn add @telefonica/libphonenumber
```

## How to update the libphonenumber version

1. Update `VERSION` variable in `update-vendor.sh` script and run it:

```bash
./update-vendor.sh
```

2. Build the package:

```bash
yarn build
```