libphonenumber-js - npm Package Compare versions

Comparing version 1.7.4 to 1.7.5

build/AsYouType.js

@@ -186,5 +186,5 @@ 'use strict';
 				if (!this.countryCallingCode) {
-					// No need to format anything
-					// if there's no national phone number.
-					// (e.g. just the country calling code)
+					// Extract country calling code from the digits entered so far.
+
+					// There must be some digits in order to extract anything from them.
 					if (!this.national_number) {
@@ -627,8 +627,3 @@ // Return raw phone number
 			// because national prefixes can't be present in international phone numbers.
-			// Otherwise, while forgiving, it would parse a NANPA number `[phone]`
-			// first to `1877 215 5230` and then, stripping the leading `1`, to `877 215 5230`,
-			// and then it would assume that's a valid number which it isn't.
-			// So no forgiveness for grandmas here.
-			// The issue asking for this fix:
-			// https://github.com/catamphetamine/libphonenumber-js/issues/159
+			// While `parseNumber()` is forgiving is such cases, `AsYouType` is not.
 
@@ -963,2 +958,10 @@ var _strip_national_prefi = (0, _parse_.strip_national_prefix_and_carrier_code)(this.national_number, this.metadata),
 		}
+
+		/**
+   * Returns an instance of `PhoneNumber` class.
+   * Will return `undefined` if no national (significant) number
+   * digits have been entered so far, or if no `defaultCountry` has been
+   * set and the user enters a phone number not in international format.
+   */
+
 	}, {
@@ -965,0 +968,0 @@ key: 'getNumber',

build/format_.js

@@ -80,2 +80,11 @@ 'use strict';
 	switch (format) {
+		case 'NATIONAL':
+			// Legacy argument support.
+			// (`{ country: ..., phone: '' }`)
+			if (!nationalNumber) {
+				return '';
+			}
+			number = format_national_number(nationalNumber, 'NATIONAL', metadata);
+			return add_extension(number, input.ext, metadata, options.formatExtension);
+
 		case 'INTERNATIONAL':
@@ -121,11 +130,2 @@ // Legacy argument support.
 
-		case 'NATIONAL':
-			// Legacy argument support.
-			// (`{ country: ..., phone: '' }`)
-			if (!nationalNumber) {
-				return '';
-			}
-			number = format_national_number(nationalNumber, 'NATIONAL', metadata);
-			return add_extension(number, input.ext, metadata, options.formatExtension);
-
 		default:
@@ -132,0 +132,0 @@ throw new Error('Unknown "format" argument passed to "formatNumber()": "' + format + '"');

build/parse_.js

@@ -462,10 +462,11 @@ 'use strict';
 
-	// Only strip national prefixes for non-international phone numbers
-	// because national prefixes can't be present in international phone numbers.
-	// Otherwise, while forgiving, it would parse a NANPA number `[phone]`
-	// first to `1877 215 5230` and then, stripping the leading `1`, to `877 215 5230`,
-	// and then it would assume that's a valid number which it isn't.
-	// So no forgiveness for grandmas here.
-	// The issue asking for this fix:
-	// https://github.com/catamphetamine/libphonenumber-js/issues/159
+	// Parsing national prefixes and carrier codes
+	// is only required for local phone numbers
+	// but some people don't understand that
+	// and sometimes write international phone numbers
+	// with national prefixes (or maybe even carrier codes).
+	// http://ucken.blogspot.ru/2016/03/trunk-prefixes-in-skype4b.html
+	// Google's original library forgives such mistakes
+	// and so does this library, because it has been requested:
+	// https://github.com/catamphetamine/libphonenumber-js/issues/127
 
@@ -472,0 +473,0 @@ var _strip_national_prefi = strip_national_prefix_and_carrier_code(national_number, metadata),

core/package.json

 {
+  "private": true,
   "name": "libphonenumber-js-core",
@@ -3,0 +4,0 @@ "version": "1.0.0",

custom.d.ts

 // `parse()` and `parseCustom` are deprecated.
 // Use `fparseNumber()` and `parseNumberCustom()` instead.
-import { CountryCallingCode, CountryCode, NumberFormat, NumberFound, NumberType, ParsedNumber, NationalNumber, PhoneNumber } from 'libphonenumber-js';
+import { Metadata, CountryCallingCode, CountryCode, NumberFormat, NumberFound, NumberType, ParsedNumber, NationalNumber, PhoneNumber, FormatNumberOptions, ParseNumberOptions } from 'libphonenumber-js';
 
-export function parsePhoneNumber(text: string, metadata: object): PhoneNumber;
-export function parsePhoneNumber(text: string, defaultCountry: CountryCode, metadata: object): PhoneNumber;
+export function parsePhoneNumber(text: string, metadata: Metadata): PhoneNumber;
+export function parsePhoneNumber(text: string, defaultCountry: CountryCode, metadata: Metadata): PhoneNumber;
 
-export function parsePhoneNumberFromString(text: string, metadata: object): PhoneNumber;
-export function parsePhoneNumberFromString(text: string, defaultCountry: CountryCode, metadata: object): PhoneNumber;
+export function parsePhoneNumberFromString(text: string, metadata: Metadata): PhoneNumber;
+export function parsePhoneNumberFromString(text: string, defaultCountry: CountryCode, metadata: Metadata): PhoneNumber;
 
@@ -15,46 +15,51 @@ export class ParseError {
 
-export function parse(text: string, metadata: object): ParsedNumber;
-export function parse(text: string, options: CountryCode | { defaultCountry?: CountryCode, extended?: boolean }, metadata: object): ParsedNumber;
+export function parse(text: string, metadata: Metadata): ParsedNumber;
+export function parse(text: string, options: CountryCode | ParseNumberOptions, metadata: Metadata): ParsedNumber;
 
-export function parseNumber(text: string, metadata: object): ParsedNumber;
-export function parseNumber(text: string, options: CountryCode | { defaultCountry?: CountryCode, extended?: boolean }, metadata: object): ParsedNumber;
+export function parseNumber(text: string, metadata: Metadata): ParsedNumber;
+export function parseNumber(text: string, options: CountryCode | ParseNumberOptions, metadata: Metadata): ParsedNumber;
 
 // `format()` and `formatCustom` are deprecated.
 // Use `formatNumber()` and `formatNumberCustom()` instead.
-export function format(parsedNumber: ParsedNumber, format: NumberFormat, metadata: object): string;
-export function format(phone: NationalNumber, format: NumberFormat, metadata: object): string;
-export function format(phone: NationalNumber, country: CountryCode, format: NumberFormat, metadata: object): string;
+export function format(parsedNumber: ParsedNumber, format: NumberFormat, metadata: Metadata): string;
+export function format(phone: NationalNumber, format: NumberFormat, metadata: Metadata): string;
+export function format(phone: NationalNumber, country: CountryCode, format: NumberFormat, metadata: Metadata): string;
 
-export function formatNumber(parsedNumber: ParsedNumber, format: NumberFormat, metadata: object): string;
-export function formatNumber(phone: NationalNumber, format: NumberFormat, metadata: object): string;
-export function formatNumber(phone: NationalNumber, country: CountryCode, format: NumberFormat, metadata: object): string;
+export function formatNumber(parsedNumber: ParsedNumber, format: NumberFormat, metadata: Metadata): string;
+export function formatNumber(parsedNumber: ParsedNumber, format: NumberFormat, options: FormatNumberOptions, metadata: Metadata): string;
 
-export function getNumberType(parsedNumber: ParsedNumber, metadata: object): NumberType;
-export function getNumberType(phone: NationalNumber, metadata: object): NumberType;
-export function getNumberType(phone: NationalNumber, country: CountryCode, metadata: object): NumberType;
+export function formatNumber(phone: NationalNumber, format: NumberFormat, metadata: Metadata): string;
+export function formatNumber(phone: NationalNumber, format: NumberFormat, options: FormatNumberOptions, metadata: Metadata): string;
 
-export function getExampleNumber(country: CountryCode, examples: object, metadata: object): PhoneNumber;
+export function formatNumber(phone: NationalNumber, country: CountryCode, format: NumberFormat, metadata: Metadata): string;
+export function formatNumber(phone: NationalNumber, country: CountryCode, format: NumberFormat, options: FormatNumberOptions, metadata: Metadata): string;
 
-export function isPossibleNumber(parsedNumber: ParsedNumber, metadata: object): boolean;
-export function isPossibleNumber(phone: NationalNumber, metadata: object): boolean;
-export function isPossibleNumber(phone: NationalNumber, country: CountryCode, metadata: object): boolean;
+export function getNumberType(parsedNumber: ParsedNumber, metadata: Metadata): NumberType;
+export function getNumberType(phone: NationalNumber, metadata: Metadata): NumberType;
+export function getNumberType(phone: NationalNumber, country: CountryCode, metadata: Metadata): NumberType;
 
-export function isValidNumber(parsedNumber: ParsedNumber, metadata: object): boolean;
-export function isValidNumber(phone: NationalNumber, metadata: object): boolean;
-export function isValidNumber(phone: NationalNumber, country: CountryCode, metadata: object): boolean;
+export function getExampleNumber(country: CountryCode, examples: object, metadata: Metadata): PhoneNumber;
 
-export function isValidNumberForRegion(phone: NationalNumber, country: CountryCode, metadata: object): boolean;
+export function isPossibleNumber(parsedNumber: ParsedNumber, metadata: Metadata): boolean;
+export function isPossibleNumber(phone: NationalNumber, metadata: Metadata): boolean;
+export function isPossibleNumber(phone: NationalNumber, country: CountryCode, metadata: Metadata): boolean;
 
+export function isValidNumber(parsedNumber: ParsedNumber, metadata: Metadata): boolean;
+export function isValidNumber(phone: NationalNumber, metadata: Metadata): boolean;
+export function isValidNumber(phone: NationalNumber, country: CountryCode, metadata: Metadata): boolean;
+
+export function isValidNumberForRegion(phone: NationalNumber, country: CountryCode, metadata: Metadata): boolean;
+
 // Deprecated.
-export function findParsedNumbers(text: string, metadata: object): NumberFound[];
-export function findParsedNumbers(text: string, options: CountryCode | { defaultCountry?: CountryCode }, metadata: object): NumberFound[];
+export function findParsedNumbers(text: string, metadata: Metadata): NumberFound[];
+export function findParsedNumbers(text: string, options: CountryCode | { defaultCountry?: CountryCode }, metadata: Metadata): NumberFound[];
 
 // Deprecated.
-export function searchParsedNumbers(text: string, metadata: object): IterableIterator<NumberFound>;
-export function searchParsedNumbers(text: string, options: CountryCode | { defaultCountry?: CountryCode }, metadata: object): IterableIterator<NumberFound>;
+export function searchParsedNumbers(text: string, metadata: Metadata): IterableIterator<NumberFound>;
+export function searchParsedNumbers(text: string, options: CountryCode | { defaultCountry?: CountryCode }, metadata: Metadata): IterableIterator<NumberFound>;
 
 // Deprecated.
 export class ParsedNumberSearch {
-  constructor(text: string, metadata: object);
-  constructor(text: string, options: { defaultCountry?: CountryCode }, metadata: object);
+  constructor(text: string, metadata: Metadata);
+  constructor(text: string, options: { defaultCountry?: CountryCode }, metadata: Metadata);
   hasNext(): boolean;
@@ -64,11 +69,11 @@ next(): NumberFound;
 
-export function findNumbers(text: string, metadata: object): NumberFound[];
-export function findNumbers(text: string, options: CountryCode | { defaultCountry?: CountryCode }, metadata: object): NumberFound[];
+export function findNumbers(text: string, metadata: Metadata): NumberFound[];
+export function findNumbers(text: string, options: CountryCode | { defaultCountry?: CountryCode }, metadata: Metadata): NumberFound[];
 
-export function searchNumbers(text: string, metadata: object): IterableIterator<NumberFound>;
-export function searchNumbers(text: string, options: CountryCode | { defaultCountry?: CountryCode }, metadata: object): IterableIterator<NumberFound>;
+export function searchNumbers(text: string, metadata: Metadata): IterableIterator<NumberFound>;
+export function searchNumbers(text: string, options: CountryCode | { defaultCountry?: CountryCode }, metadata: Metadata): IterableIterator<NumberFound>;
 
 export class ParsedNumberMatcher {
-  constructor(text: string, metadata: object);
-  constructor(text: string, options: { defaultCountry?: CountryCode }, metadata: object);
+  constructor(text: string, metadata: Metadata);
+  constructor(text: string, options: { defaultCountry?: CountryCode }, metadata: Metadata);
   hasNext(): boolean;
@@ -78,8 +83,8 @@ next(): NumberFound;
 
-export function getCountryCallingCode(countryCode: CountryCode, metadata: object): CountryCallingCode;
+export function getCountryCallingCode(countryCode: CountryCode, metadata: Metadata): CountryCallingCode;
 
-export function getPhoneCode(countryCode: CountryCode, metadata: object): CountryCallingCode;
+export function getPhoneCode(countryCode: CountryCode, metadata: Metadata): CountryCallingCode;
 
-export function formatIncompletePhoneNumber(number: string, metadata: object): string;
-export function formatIncompletePhoneNumber(number: string, countryCode: CountryCode, metadata: object): string;
+export function formatIncompletePhoneNumber(number: string, metadata: Metadata): string;
+export function formatIncompletePhoneNumber(number: string, countryCode: CountryCode, metadata: Metadata): string;
 export function parseIncompletePhoneNumber(text: string): string;
@@ -90,3 +95,3 @@ export function parsePhoneNumberCharacter(character: string): string;
 export class AsYouType {
-  constructor(defaultCountryCode: CountryCode, metadata: object);
+  constructor(defaultCountryCode: CountryCode, metadata: Metadata);
   input(text: string): string;
@@ -93,0 +98,0 @@ reset(): void;

es6/AsYouType.js

@@ -167,5 +167,5 @@ var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
 				if (!this.countryCallingCode) {
-					// No need to format anything
-					// if there's no national phone number.
-					// (e.g. just the country calling code)
+					// Extract country calling code from the digits entered so far.
+
+					// There must be some digits in order to extract anything from them.
 					if (!this.national_number) {
@@ -608,8 +608,3 @@ // Return raw phone number
 			// because national prefixes can't be present in international phone numbers.
-			// Otherwise, while forgiving, it would parse a NANPA number `[phone]`
-			// first to `1877 215 5230` and then, stripping the leading `1`, to `877 215 5230`,
-			// and then it would assume that's a valid number which it isn't.
-			// So no forgiveness for grandmas here.
-			// The issue asking for this fix:
-			// https://github.com/catamphetamine/libphonenumber-js/issues/159
+			// While `parseNumber()` is forgiving is such cases, `AsYouType` is not.
 
@@ -944,2 +939,10 @@ var _strip_national_prefi = strip_national_prefix_and_carrier_code(this.national_number, this.metadata),
 		}
+
+		/**
+   * Returns an instance of `PhoneNumber` class.
+   * Will return `undefined` if no national (significant) number
+   * digits have been entered so far, or if no `defaultCountry` has been
+   * set and the user enters a phone number not in international format.
+   */
+
 	}, {
@@ -946,0 +949,0 @@ key: 'getNumber',

es6/format_.js

@@ -61,2 +61,11 @@ var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
 	switch (format) {
+		case 'NATIONAL':
+			// Legacy argument support.
+			// (`{ country: ..., phone: '' }`)
+			if (!nationalNumber) {
+				return '';
+			}
+			number = format_national_number(nationalNumber, 'NATIONAL', metadata);
+			return add_extension(number, input.ext, metadata, options.formatExtension);
+
 		case 'INTERNATIONAL':
@@ -102,11 +111,2 @@ // Legacy argument support.
 
-		case 'NATIONAL':
-			// Legacy argument support.
-			// (`{ country: ..., phone: '' }`)
-			if (!nationalNumber) {
-				return '';
-			}
-			number = format_national_number(nationalNumber, 'NATIONAL', metadata);
-			return add_extension(number, input.ext, metadata, options.formatExtension);
-
 		default:
@@ -113,0 +113,0 @@ throw new Error('Unknown "format" argument passed to "formatNumber()": "' + format + '"');

es6/parse_.js

@@ -424,10 +424,11 @@ // This is a port of Google Android `libphonenumber`'s
 
-	// Only strip national prefixes for non-international phone numbers
-	// because national prefixes can't be present in international phone numbers.
-	// Otherwise, while forgiving, it would parse a NANPA number `[phone]`
-	// first to `1877 215 5230` and then, stripping the leading `1`, to `877 215 5230`,
-	// and then it would assume that's a valid number which it isn't.
-	// So no forgiveness for grandmas here.
-	// The issue asking for this fix:
-	// https://github.com/catamphetamine/libphonenumber-js/issues/159
+	// Parsing national prefixes and carrier codes
+	// is only required for local phone numbers
+	// but some people don't understand that
+	// and sometimes write international phone numbers
+	// with national prefixes (or maybe even carrier codes).
+	// http://ucken.blogspot.ru/2016/03/trunk-prefixes-in-skype4b.html
+	// Google's original library forgives such mistakes
+	// and so does this library, because it has been requested:
+	// https://github.com/catamphetamine/libphonenumber-js/issues/127
 
@@ -434,0 +435,0 @@ var _strip_national_prefi = strip_national_prefix_and_carrier_code(national_number, metadata),

index.d.ts

 export type CountryCode = '001' | 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW';
 
+export type CountryCallingCodes = {
+  [countryCallingCode: string]: CountryCode[];
+};
+
+export type Countries = {
+  [country in CountryCode]: any[];
+};
+
+export type Metadata = {
+  country_calling_codes: CountryCallingCodes;
+  countries: Countries;
+};
+
 export type NumberFormat = 'NATIONAL' | 'National' | 'INTERNATIONAL' | 'International' | 'E.164' | 'RFC3966' | 'IDD';
@@ -10,4 +23,24 @@ export type NumberType = undefined | 'PREMIUM_RATE' | 'TOLL_FREE' | 'SHARED_COST' | 'VOIP' | 'PERSONAL_NUMBER' | 'PAGER' | 'UAN' | 'VOICEMAIL' | 'FIXED_LINE_OR_MOBILE' | 'FIXED_LINE' | 'MOBILE';
 
+type FormatExtension = (number: string, extension: string, metadata: Metadata) => string
+type FormatNumberOptionsWithoutIDD = {
+  v2?: boolean;
+  formatExtension?: FormatExtension;
+};
+
+// Legacy.
+export type FormatNumberOptions = {
+  v2?: boolean;
+  fromCountry?: CountryCode;
+  humanReadable?: boolean;
+  formatExtension?: FormatExtension
+};
+
+// Legacy.
+export type ParseNumberOptions = {
+  defaultCountry?: CountryCode;
+  extended?: boolean;
+};
+
 export class PhoneNumber {
-  constructor(countryCallingCodeOrCountry: CountryCallingCode | CountryCode, nationalNumber: NationalNumber, metadata: object);
+  constructor(countryCallingCodeOrCountry: CountryCallingCode | CountryCode, nationalNumber: NationalNumber, metadata: Metadata);
   countryCallingCode: CountryCallingCode;
@@ -22,5 +55,5 @@ country?: CountryCode;
   getType(): NumberType;
-  format(format: NumberFormat, options?: object): string;
-  formatNational(options?: object): string;
-  formatInternational(options?: object): string;
+  format(format: NumberFormat, options?: FormatNumberOptions): string;
+  formatNational(options?: FormatNumberOptionsWithoutIDD): string;
+  formatInternational(options?: FormatNumberOptionsWithoutIDD): string;
   getURI(options?: object): string;
@@ -56,5 +89,5 @@ }
 // Use `fparseNumber()` and `parseNumberCustom()` instead.
-export function parse(text: string, options?: CountryCode | { defaultCountry?: CountryCode, extended?: boolean }): ParsedNumber;
+export function parse(text: string, options?: CountryCode | ParseNumberOptions): ParsedNumber;
 
-export function parseNumber(text: string, options?: CountryCode | { defaultCountry?: CountryCode, extended?: boolean }): ParsedNumber;
+export function parseNumber(text: string, options?: CountryCode | ParseNumberOptions): ParsedNumber;
 
@@ -67,5 +100,5 @@ // `format()` and `formatCustom` are deprecated.
 
-export function formatNumber(parsedNumber: ParsedNumber, format: NumberFormat): string;
-export function formatNumber(phone: NationalNumber, format: NumberFormat): string;
-export function formatNumber(phone: NationalNumber, country: CountryCode, format: NumberFormat): string;
+export function formatNumber(parsedNumber: ParsedNumber, format: NumberFormat, options?: FormatNumberOptions): string;
+export function formatNumber(phone: NationalNumber, format: NumberFormat, options?: FormatNumberOptions): string;
+export function formatNumber(phone: NationalNumber, country: CountryCode, format: NumberFormat, options?: FormatNumberOptions): string;
 
@@ -72,0 +105,0 @@ export function getNumberType(parsedNumber: ParsedNumber): NumberType;

max/package.json

 {
+  "private": true,
   "name": "libphonenumber-js-max",
@@ -3,0 +4,0 @@ "version": "1.0.0",

min/package.json

 {
+  "private": true,
   "name": "libphonenumber-js-min",
@@ -3,0 +4,0 @@ "version": "1.0.0",

mobile/package.json

 {
+  "private": true,
   "name": "libphonenumber-js-mobile",
@@ -3,0 +4,0 @@ "version": "1.0.0",

package.json

 {
   "name": "libphonenumber-js",
-  "version": "1.7.4",
+  "version": "1.7.5",
   "description": "A simpler (and smaller) rewrite of Google Android's popular libphonenumber library",
@@ -5,0 +5,0 @@ "main": "index.common.js",

README.md

@@ -56,3 +56,3 @@ # libphonenumber-js
 
-* `min` — The smallest metadata set, is about `75 kilobytes` in size (`libphonenumber-js/metadata.min.json`). Doesn't contain regular expressions for advanced phone number validation ([`.isValid()`](https://github.com/catamphetamine/libphonenumber-js#isvalid)) and determining phone number type ([`.getType()`](https://github.com/catamphetamine/libphonenumber-js#gettype)).
+* `min` — (default) The smallest metadata set, is about `75 kilobytes` in size (`libphonenumber-js/metadata.min.json`). Doesn't contain regular expressions for advanced phone number validation ([`.isValid()`](https://github.com/catamphetamine/libphonenumber-js#isvalid)) and determining phone number type ([`.getType()`](https://github.com/catamphetamine/libphonenumber-js#gettype)). Some simple phone number validation via `.isValid()` still works (basic length check, etc), it's just that it's loose compared to the "advanced" validation (not so strict).
 
@@ -63,3 +63,3 @@ * `mobile` — The complete metadata set for dealing with mobile numbers _only_, is about `105 kilobytes` in size (`libphonenumber-js/metadata.mobile.json`).
 
-Importing functions directly from `libhponenumber-js` results in using the `min` metadata (which means no support for `.isValid()` and `.getType()`).
+Importing functions directly from `libhponenumber-js` results in using the `min` metadata which means loose (non-strict) phone number validation via `.isValid()` and no getting phone number type via `.getType()`.
 
@@ -392,3 +392,3 @@ Sometimes (rarely) not all countries are needed and in those cases the developers may want to [generate](https://github.com/catamphetamine/libphonenumber-js#customizing-metadata) their own "custom" metadata set. For those cases there's `libphonenumber-js/core` sub-package which doesn't come pre-wired with any default metadata and instead accepts the metadata as the last argument of each exported function.
 
- * `getNumber()` — Returns the [`PhoneNumber`](#phonenumber). Will return `undefined` if no [national (significant) number](#national-significant-number) has been entered so far, or if no `defaultCountry` has been set and the user enters a phone number not in international format.
+ * `getNumber()` — Returns the [`PhoneNumber`](#phonenumber). Will return `undefined` if no [national (significant) number](#national-significant-number) digits have been entered so far, or if no `defaultCountry` has been set and the user enters a phone number not in international format.
 
@@ -395,0 +395,0 @@ * `getTemplate()` — Returns the template used to format the output. Digits (and the `+` sign, if present) are denoted by `x`-es. Will return `undefined` if no suitable format was found for the number being entered (or if no [national (significant) number](#national-significant-number) has been entered so far).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2025034

increased by0.03%

Lines of code

12477

increased by0.26%

No dependency changes