@types/google-libphonenumber
- Version 7.4.23
- Published
- 10.4 kB
- No dependencies
- MIT license
Install
npm i @types/google-libphonenumber
yarn add @types/google-libphonenumber
pnpm add @types/google-libphonenumber
Overview
TypeScript definitions for libphonenumber
Index
Namespaces
Namespaces
namespace google-libphonenumber
module 'google-libphonenumber' {}
class AsYouTypeFormatter
class AsYouTypeFormatter {}
constructor
constructor(region: string);
method clear
clear: () => void;
method inputDigit
inputDigit: (digit: string) => string;
class PhoneNumber
class PhoneNumber {}
method clearCountryCode
clearCountryCode: () => void;
method clearCountryCodeSource
clearCountryCodeSource: () => void;
method clearExtension
clearExtension: () => void;
method clearItalianLeadingZero
clearItalianLeadingZero: () => void;
method clearNationalNumber
clearNationalNumber: () => void;
method clearNumberOfLeadingZeros
clearNumberOfLeadingZeros: () => void;
method clearPreferredDomesticCarrierCode
clearPreferredDomesticCarrierCode: () => void;
method clearRawInput
clearRawInput: () => void;
method countryCodeCount
countryCodeCount: () => number;
method countryCodeSourceCount
countryCodeSourceCount: () => number;
method extensionCount
extensionCount: () => number;
method getCountryCode
getCountryCode: () => number | undefined;
method getCountryCodeOrDefault
getCountryCodeOrDefault: () => number;
method getCountryCodeSource
getCountryCodeSource: () => PhoneNumber.CountryCodeSource | undefined;
method getCountryCodeSourceOrDefault
getCountryCodeSourceOrDefault: () => PhoneNumber.CountryCodeSource;
method getExtension
getExtension: () => string | undefined;
method getExtensionOrDefault
getExtensionOrDefault: () => string;
method getItalianLeadingZero
getItalianLeadingZero: () => boolean | undefined;
method getItalianLeadingZeroOrDefault
getItalianLeadingZeroOrDefault: () => boolean;
method getNationalNumber
getNationalNumber: () => number | undefined;
method getNationalNumberOrDefault
getNationalNumberOrDefault: () => number;
method getNumberOfLeadingZeros
getNumberOfLeadingZeros: () => number | undefined;
method getNumberOfLeadingZerosOrDefault
getNumberOfLeadingZerosOrDefault: () => number;
method getPreferredDomesticCarrierCode
getPreferredDomesticCarrierCode: () => string | undefined;
method getPreferredDomesticCarrierCodeOrDefault
getPreferredDomesticCarrierCodeOrDefault: () => string;
method getRawInput
getRawInput: () => string | undefined;
method getRawInputOrDefault
getRawInputOrDefault: () => string;
method hasCountryCode
hasCountryCode: () => boolean;
method hasCountryCodeSource
hasCountryCodeSource: () => boolean;
method hasExtension
hasExtension: () => boolean;
method hasItalianLeadingZero
hasItalianLeadingZero: () => boolean;
method hasNationalNumber
hasNationalNumber: () => boolean;
method hasNumberOfLeadingZeros
hasNumberOfLeadingZeros: () => boolean;
method hasPreferredDomesticCarrierCode
hasPreferredDomesticCarrierCode: () => boolean;
method hasRawInput
hasRawInput: () => boolean;
method italianLeadingZeroCount
italianLeadingZeroCount: () => number;
method nationalNumberCount
nationalNumberCount: () => number;
method numberOfLeadingZerosCount
numberOfLeadingZerosCount: () => number;
method preferredDomesticCarrierCodeCount
preferredDomesticCarrierCodeCount: () => number;
method rawInputCount
rawInputCount: () => number;
method setCountryCode
setCountryCode: (value: number) => void;
method setCountryCodeSource
setCountryCodeSource: (value: PhoneNumber.CountryCodeSource) => void;
method setExtension
setExtension: (value: string) => void;
method setItalianLeadingZero
setItalianLeadingZero: (value: boolean) => void;
method setNationalNumber
setNationalNumber: (value: number) => number;
method setNumberOfLeadingZeros
setNumberOfLeadingZeros: (value: number) => void;
method setPreferredDomesticCarrierCode
setPreferredDomesticCarrierCode: (value: string) => void;
method setRawInput
setRawInput: (value: string) => void;
class PhoneNumberUtil
class PhoneNumberUtil {}
method extractCountryCode
extractCountryCode: ( fullNumber: StringBuffer, nationalNumber: StringBuffer) => number;
method format
format: (phoneNumber: PhoneNumber, format: PhoneNumberFormat) => string;
method formatInOriginalFormat
formatInOriginalFormat: ( phoneNumber: PhoneNumber, regionDialingFrom?: string) => string;
method formatOutOfCountryCallingNumber
formatOutOfCountryCallingNumber: ( phoneNumber: PhoneNumber, regionDialingFrom?: string) => string;
method getCountryCodeForRegion
getCountryCodeForRegion: (supportedRegion: string) => number;
method getExampleNumber
getExampleNumber: (regionCode: string) => PhoneNumber;
method getExampleNumberForType
getExampleNumberForType: ( regionCode: string, type: PhoneNumberType) => PhoneNumber;
method getInstance
static getInstance: () => PhoneNumberUtil;
method getLengthOfGeographicalAreaCode
getLengthOfGeographicalAreaCode: (number: PhoneNumber) => number;
method getNationalSignificantNumber
getNationalSignificantNumber: (number: PhoneNumber) => string;
method getNddPrefixForRegion
getNddPrefixForRegion: ( regionCode?: string, stripNonDigits?: boolean) => string | undefined;
method getNumberType
getNumberType: (phoneNumber: PhoneNumber) => PhoneNumberType;
method getRegionCodeForCountryCode
getRegionCodeForCountryCode: (countryCallingCode: number) => string;
method getRegionCodeForNumber
getRegionCodeForNumber: (phoneNumber: PhoneNumber) => string | undefined;
method getSupportedRegions
getSupportedRegions: () => string[];
method isAlphaNumber
isAlphaNumber: (number: string) => boolean;
method isLeadingZeroPossible
isLeadingZeroPossible: (countryCallingCode: number) => boolean;
method isNANPACountry
isNANPACountry: (regionCode?: string) => boolean;
method isNumberMatch
isNumberMatch: ( firstNumber: string | PhoneNumber, secondNumber: string | PhoneNumber) => PhoneNumberUtil.MatchType;
method isPossibleNumber
isPossibleNumber: { (number: PhoneNumber): boolean; (phoneNumber: PhoneNumber): boolean;};
method isPossibleNumberForType
isPossibleNumberForType: (number: PhoneNumber, type: PhoneNumberType) => boolean;
method isPossibleNumberForTypeWithReason
isPossibleNumberForTypeWithReason: ( number: PhoneNumber, type: PhoneNumberType) => PhoneNumberUtil.ValidationResult;
method isPossibleNumberString
isPossibleNumberString: (number: string, regionDialingFrom: string) => boolean;
method isPossibleNumberWithReason
isPossibleNumberWithReason: { (number: PhoneNumber): PhoneNumberUtil.ValidationResult; (phoneNumber: PhoneNumber): PhoneNumberUtil.ValidationResult;};
method isValidNumber
isValidNumber: (phoneNumber: PhoneNumber) => boolean;
method isValidNumberForRegion
isValidNumberForRegion: (phoneNumber: PhoneNumber, region?: string) => boolean;
method parse
parse: (number?: string, region?: string) => PhoneNumber;
method parseAndKeepRawInput
parseAndKeepRawInput: (number: string, regionCode?: string) => PhoneNumber;
method truncateTooLongNumber
truncateTooLongNumber: (number: PhoneNumber) => boolean;
class StringBuffer
class StringBuffer {}
constructor
constructor(opt_a1?: any, ...var_args: any[]);
method append
append: (a1: any, opt_a2?: any, ...var_args: any[]) => StringBuffer;
method toString
toString: () => string;
enum PhoneNumberFormat
enum PhoneNumberFormat { E164, INTERNATIONAL, NATIONAL, RFC3966,}
enum PhoneNumberType
enum PhoneNumberType { FIXED_LINE = 0, MOBILE = 1, FIXED_LINE_OR_MOBILE = 2, TOLL_FREE = 3, PREMIUM_RATE = 4, SHARED_COST = 5, VOIP = 6, PERSONAL_NUMBER = 7, PAGER = 8, UAN = 9, VOICEMAIL = 10, UNKNOWN = -1,}
member FIXED_LINE
FIXED_LINE = 0
member FIXED_LINE_OR_MOBILE
FIXED_LINE_OR_MOBILE = 2
member MOBILE
MOBILE = 1
member PAGER
PAGER = 8
member PERSONAL_NUMBER
PERSONAL_NUMBER = 7
member PREMIUM_RATE
PREMIUM_RATE = 4
member SHARED_COST
SHARED_COST = 5
member TOLL_FREE
TOLL_FREE = 3
member UAN
UAN = 9
member UNKNOWN
UNKNOWN = -1
member VOICEMAIL
VOICEMAIL = 10
member VOIP
VOIP = 6
namespace google-libphonenumber.PhoneNumber
namespace google-libphonenumber.PhoneNumber {}
enum CountryCodeSource
enum CountryCodeSource { FROM_NUMBER_WITH_PLUS_SIGN = 1, FROM_NUMBER_WITH_IDD = 5, FROM_NUMBER_WITHOUT_PLUS_SIGN = 10, FROM_DEFAULT_COUNTRY = 20,}
member FROM_DEFAULT_COUNTRY
FROM_DEFAULT_COUNTRY = 20
member FROM_NUMBER_WITH_IDD
FROM_NUMBER_WITH_IDD = 5
member FROM_NUMBER_WITH_PLUS_SIGN
FROM_NUMBER_WITH_PLUS_SIGN = 1
member FROM_NUMBER_WITHOUT_PLUS_SIGN
FROM_NUMBER_WITHOUT_PLUS_SIGN = 10
namespace google-libphonenumber.PhoneNumberUtil
namespace google-libphonenumber.PhoneNumberUtil {}
enum MatchType
enum MatchType { EXACT_MATCH, NO_MATCH, NOT_A_NUMBER, NSN_MATCH, SHORT_NSN_MATCH,}
member EXACT_MATCH
EXACT_MATCH
member NO_MATCH
NO_MATCH
member NOT_A_NUMBER
NOT_A_NUMBER
member NSN_MATCH
NSN_MATCH
member SHORT_NSN_MATCH
SHORT_NSN_MATCH
enum ValidationResult
enum ValidationResult { IS_POSSIBLE, INVALID_COUNTRY_CODE, TOO_SHORT, TOO_LONG, IS_POSSIBLE_LOCAL_ONLY, INVALID_LENGTH,}
member INVALID_COUNTRY_CODE
INVALID_COUNTRY_CODE
The number has an invalid country calling code. =1
member INVALID_LENGTH
INVALID_LENGTH
The number is longer than the shortest valid numbers for this region, shorter than the longest valid numbers for this region, and does not itself have a number length that matches valid numbers for this region. This can also be returned in the case where isPossibleNumberForTypeWithReason was called, and there are no numbers of this type at all for this region. =5
member IS_POSSIBLE
IS_POSSIBLE
The number length matches that of valid numbers for this region. =0
member IS_POSSIBLE_LOCAL_ONLY
IS_POSSIBLE_LOCAL_ONLY
The number length matches that of local numbers for this region only (i.e. numbers that may be able to be dialled within an area, but do not have all the information to be dialled from anywhere inside or outside the country). =4
member TOO_LONG
TOO_LONG
The number is longer than all valid numbers for this region. =3
member TOO_SHORT
TOO_SHORT
The number is shorter than all valid numbers for this region. =2
namespace libphonenumber
namespace libphonenumber {}
class AsYouTypeFormatter
class AsYouTypeFormatter {}
constructor
constructor(region: string);
method clear
clear: () => void;
method inputDigit
inputDigit: (digit: string) => string;
class PhoneNumber
class PhoneNumber {}
method clearCountryCode
clearCountryCode: () => void;
method clearCountryCodeSource
clearCountryCodeSource: () => void;
method clearExtension
clearExtension: () => void;
method clearItalianLeadingZero
clearItalianLeadingZero: () => void;
method clearNationalNumber
clearNationalNumber: () => void;
method clearNumberOfLeadingZeros
clearNumberOfLeadingZeros: () => void;
method clearPreferredDomesticCarrierCode
clearPreferredDomesticCarrierCode: () => void;
method clearRawInput
clearRawInput: () => void;
method countryCodeCount
countryCodeCount: () => number;
method countryCodeSourceCount
countryCodeSourceCount: () => number;
method extensionCount
extensionCount: () => number;
method getCountryCode
getCountryCode: () => number | undefined;
method getCountryCodeOrDefault
getCountryCodeOrDefault: () => number;
method getCountryCodeSource
getCountryCodeSource: () => PhoneNumber.CountryCodeSource | undefined;
method getCountryCodeSourceOrDefault
getCountryCodeSourceOrDefault: () => PhoneNumber.CountryCodeSource;
method getExtension
getExtension: () => string | undefined;
method getExtensionOrDefault
getExtensionOrDefault: () => string;
method getItalianLeadingZero
getItalianLeadingZero: () => boolean | undefined;
method getItalianLeadingZeroOrDefault
getItalianLeadingZeroOrDefault: () => boolean;
method getNationalNumber
getNationalNumber: () => number | undefined;
method getNationalNumberOrDefault
getNationalNumberOrDefault: () => number;
method getNumberOfLeadingZeros
getNumberOfLeadingZeros: () => number | undefined;
method getNumberOfLeadingZerosOrDefault
getNumberOfLeadingZerosOrDefault: () => number;
method getPreferredDomesticCarrierCode
getPreferredDomesticCarrierCode: () => string | undefined;
method getPreferredDomesticCarrierCodeOrDefault
getPreferredDomesticCarrierCodeOrDefault: () => string;
method getRawInput
getRawInput: () => string | undefined;
method getRawInputOrDefault
getRawInputOrDefault: () => string;
method hasCountryCode
hasCountryCode: () => boolean;
method hasCountryCodeSource
hasCountryCodeSource: () => boolean;
method hasExtension
hasExtension: () => boolean;
method hasItalianLeadingZero
hasItalianLeadingZero: () => boolean;
method hasNationalNumber
hasNationalNumber: () => boolean;
method hasNumberOfLeadingZeros
hasNumberOfLeadingZeros: () => boolean;
method hasPreferredDomesticCarrierCode
hasPreferredDomesticCarrierCode: () => boolean;
method hasRawInput
hasRawInput: () => boolean;
method italianLeadingZeroCount
italianLeadingZeroCount: () => number;
method nationalNumberCount
nationalNumberCount: () => number;
method numberOfLeadingZerosCount
numberOfLeadingZerosCount: () => number;
method preferredDomesticCarrierCodeCount
preferredDomesticCarrierCodeCount: () => number;
method rawInputCount
rawInputCount: () => number;
method setCountryCode
setCountryCode: (value: number) => void;
method setCountryCodeSource
setCountryCodeSource: (value: PhoneNumber.CountryCodeSource) => void;
method setExtension
setExtension: (value: string) => void;
method setItalianLeadingZero
setItalianLeadingZero: (value: boolean) => void;
method setNationalNumber
setNationalNumber: (value: number) => number;
method setNumberOfLeadingZeros
setNumberOfLeadingZeros: (value: number) => void;
method setPreferredDomesticCarrierCode
setPreferredDomesticCarrierCode: (value: string) => void;
method setRawInput
setRawInput: (value: string) => void;
class PhoneNumberUtil
class PhoneNumberUtil {}
method extractCountryCode
extractCountryCode: ( fullNumber: StringBuffer, nationalNumber: StringBuffer) => number;
method format
format: (phoneNumber: PhoneNumber, format: PhoneNumberFormat) => string;
method formatInOriginalFormat
formatInOriginalFormat: ( phoneNumber: PhoneNumber, regionDialingFrom?: string) => string;
method formatOutOfCountryCallingNumber
formatOutOfCountryCallingNumber: ( phoneNumber: PhoneNumber, regionDialingFrom?: string) => string;
method getCountryCodeForRegion
getCountryCodeForRegion: (supportedRegion: string) => number;
method getExampleNumber
getExampleNumber: (regionCode: string) => PhoneNumber;
method getExampleNumberForType
getExampleNumberForType: ( regionCode: string, type: PhoneNumberType) => PhoneNumber;
method getInstance
static getInstance: () => PhoneNumberUtil;
method getLengthOfGeographicalAreaCode
getLengthOfGeographicalAreaCode: (number: PhoneNumber) => number;
method getNationalSignificantNumber
getNationalSignificantNumber: (number: PhoneNumber) => string;
method getNddPrefixForRegion
getNddPrefixForRegion: ( regionCode?: string, stripNonDigits?: boolean) => string | undefined;
method getNumberType
getNumberType: (phoneNumber: PhoneNumber) => PhoneNumberType;
method getRegionCodeForCountryCode
getRegionCodeForCountryCode: (countryCallingCode: number) => string;
method getRegionCodeForNumber
getRegionCodeForNumber: (phoneNumber: PhoneNumber) => string | undefined;
method getSupportedRegions
getSupportedRegions: () => string[];
method isAlphaNumber
isAlphaNumber: (number: string) => boolean;
method isLeadingZeroPossible
isLeadingZeroPossible: (countryCallingCode: number) => boolean;
method isNANPACountry
isNANPACountry: (regionCode?: string) => boolean;
method isNumberMatch
isNumberMatch: ( firstNumber: string | PhoneNumber, secondNumber: string | PhoneNumber) => PhoneNumberUtil.MatchType;
method isPossibleNumber
isPossibleNumber: { (number: PhoneNumber): boolean; (phoneNumber: PhoneNumber): boolean;};
method isPossibleNumberForType
isPossibleNumberForType: (number: PhoneNumber, type: PhoneNumberType) => boolean;
method isPossibleNumberForTypeWithReason
isPossibleNumberForTypeWithReason: ( number: PhoneNumber, type: PhoneNumberType) => PhoneNumberUtil.ValidationResult;
method isPossibleNumberString
isPossibleNumberString: (number: string, regionDialingFrom: string) => boolean;
method isPossibleNumberWithReason
isPossibleNumberWithReason: { (number: PhoneNumber): PhoneNumberUtil.ValidationResult; (phoneNumber: PhoneNumber): PhoneNumberUtil.ValidationResult;};
method isValidNumber
isValidNumber: (phoneNumber: PhoneNumber) => boolean;
method isValidNumberForRegion
isValidNumberForRegion: (phoneNumber: PhoneNumber, region?: string) => boolean;
method parse
parse: (number?: string, region?: string) => PhoneNumber;
method parseAndKeepRawInput
parseAndKeepRawInput: (number: string, regionCode?: string) => PhoneNumber;
method truncateTooLongNumber
truncateTooLongNumber: (number: PhoneNumber) => boolean;
class StringBuffer
class StringBuffer {}
constructor
constructor(opt_a1?: any, ...var_args: any[]);
method append
append: (a1: any, opt_a2?: any, ...var_args: any[]) => StringBuffer;
method toString
toString: () => string;
enum PhoneNumberFormat
enum PhoneNumberFormat { E164, INTERNATIONAL, NATIONAL, RFC3966,}
enum PhoneNumberType
enum PhoneNumberType { FIXED_LINE = 0, MOBILE = 1, FIXED_LINE_OR_MOBILE = 2, TOLL_FREE = 3, PREMIUM_RATE = 4, SHARED_COST = 5, VOIP = 6, PERSONAL_NUMBER = 7, PAGER = 8, UAN = 9, VOICEMAIL = 10, UNKNOWN = -1,}
member FIXED_LINE
FIXED_LINE = 0
member FIXED_LINE_OR_MOBILE
FIXED_LINE_OR_MOBILE = 2
member MOBILE
MOBILE = 1
member PAGER
PAGER = 8
member PERSONAL_NUMBER
PERSONAL_NUMBER = 7
member PREMIUM_RATE
PREMIUM_RATE = 4
member SHARED_COST
SHARED_COST = 5
member TOLL_FREE
TOLL_FREE = 3
member UAN
UAN = 9
member UNKNOWN
UNKNOWN = -1
member VOICEMAIL
VOICEMAIL = 10
member VOIP
VOIP = 6
namespace libphonenumber.PhoneNumber
namespace libphonenumber.PhoneNumber {}
enum CountryCodeSource
enum CountryCodeSource { FROM_NUMBER_WITH_PLUS_SIGN = 1, FROM_NUMBER_WITH_IDD = 5, FROM_NUMBER_WITHOUT_PLUS_SIGN = 10, FROM_DEFAULT_COUNTRY = 20,}
member FROM_DEFAULT_COUNTRY
FROM_DEFAULT_COUNTRY = 20
member FROM_NUMBER_WITH_IDD
FROM_NUMBER_WITH_IDD = 5
member FROM_NUMBER_WITH_PLUS_SIGN
FROM_NUMBER_WITH_PLUS_SIGN = 1
member FROM_NUMBER_WITHOUT_PLUS_SIGN
FROM_NUMBER_WITHOUT_PLUS_SIGN = 10
namespace libphonenumber.PhoneNumberUtil
namespace libphonenumber.PhoneNumberUtil {}
enum MatchType
enum MatchType { EXACT_MATCH, NO_MATCH, NOT_A_NUMBER, NSN_MATCH, SHORT_NSN_MATCH,}
member EXACT_MATCH
EXACT_MATCH
member NO_MATCH
NO_MATCH
member NOT_A_NUMBER
NOT_A_NUMBER
member NSN_MATCH
NSN_MATCH
member SHORT_NSN_MATCH
SHORT_NSN_MATCH
enum ValidationResult
enum ValidationResult { IS_POSSIBLE, INVALID_COUNTRY_CODE, TOO_SHORT, TOO_LONG, IS_POSSIBLE_LOCAL_ONLY, INVALID_LENGTH,}
member INVALID_COUNTRY_CODE
INVALID_COUNTRY_CODE
The number has an invalid country calling code. =1
member INVALID_LENGTH
INVALID_LENGTH
The number is longer than the shortest valid numbers for this region, shorter than the longest valid numbers for this region, and does not itself have a number length that matches valid numbers for this region. This can also be returned in the case where isPossibleNumberForTypeWithReason was called, and there are no numbers of this type at all for this region. =5
member IS_POSSIBLE
IS_POSSIBLE
The number length matches that of valid numbers for this region. =0
member IS_POSSIBLE_LOCAL_ONLY
IS_POSSIBLE_LOCAL_ONLY
The number length matches that of local numbers for this region only (i.e. numbers that may be able to be dialled within an area, but do not have all the information to be dialled from anywhere inside or outside the country). =4
member TOO_LONG
TOO_LONG
The number is longer than all valid numbers for this region. =3
member TOO_SHORT
TOO_SHORT
The number is shorter than all valid numbers for this region. =2
Package Files (1)
Dependencies (0)
No dependencies.
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/google-libphonenumber
.
- Markdown[](https://www.jsdocs.io/package/@types/google-libphonenumber)
- HTML<a href="https://www.jsdocs.io/package/@types/google-libphonenumber"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 5553 ms. - Missing or incorrect documentation? Open an issue for this package.