@celo/phone-utils › "phoneNumbers"
Module: "phoneNumbers"
Index
Functions
- getCountryCode
- getDisplayNumberInternational
- getDisplayPhoneNumber
- getE164DisplayNumber
- getE164Number
- getExampleNumber
- getRegionCode
- getRegionCodeFromCountryCode
- isE164NumberStrict
- parsePhoneNumber
Object literals
Functions
getCountryCode
▸ getCountryCode(e164PhoneNumber
: string): undefined | null | number
Defined in phoneNumbers.ts:13
Parameters:
Name | Type |
---|---|
e164PhoneNumber |
string |
Returns: undefined | null | number
getDisplayNumberInternational
▸ getDisplayNumberInternational(e164PhoneNumber
: string): string
Defined in phoneNumbers.ts:59
Parameters:
Name | Type |
---|---|
e164PhoneNumber |
string |
Returns: string
getDisplayPhoneNumber
▸ getDisplayPhoneNumber(phoneNumber
: string, defaultCountryCode
: string): string
Defined in phoneNumbers.ts:49
Parameters:
Name | Type |
---|---|
phoneNumber |
string |
defaultCountryCode |
string |
Returns: string
getE164DisplayNumber
▸ getE164DisplayNumber(e164PhoneNumber
: string): string
Defined in phoneNumbers.ts:70
Parameters:
Name | Type |
---|---|
e164PhoneNumber |
string |
Returns: string
getE164Number
▸ getE164Number(phoneNumber
: string, defaultCountryCode
: string): null | string
Defined in phoneNumbers.ts:75
Parameters:
Name | Type |
---|---|
phoneNumber |
string |
defaultCountryCode |
string |
Returns: null | string
getExampleNumber
▸ getExampleNumber(regionCode
: string, useOnlyZeroes
: boolean, isInternational
: boolean): undefined | string
Defined in phoneNumbers.ts:212
Parameters:
Name | Type | Default |
---|---|---|
regionCode |
string | - |
useOnlyZeroes |
boolean | true |
isInternational |
boolean | false |
Returns: undefined | string
getRegionCode
▸ getRegionCode(e164PhoneNumber
: string): undefined | null | string
Defined in phoneNumbers.ts:25
Parameters:
Name | Type |
---|---|
e164PhoneNumber |
string |
Returns: undefined | null | string
getRegionCodeFromCountryCode
▸ getRegionCodeFromCountryCode(countryCode
: string): null | string
Defined in phoneNumbers.ts:37
Parameters:
Name | Type |
---|---|
countryCode |
string |
Returns: null | string
isE164NumberStrict
▸ isE164NumberStrict(phoneNumber
: string): boolean
Defined in phoneNumbers.ts:85
Parameters:
Name | Type |
---|---|
phoneNumber |
string |
Returns: boolean
parsePhoneNumber
▸ parsePhoneNumber(phoneNumberRaw
: string, defaultCountryCode?
: undefined | string): ParsedPhoneNumber | null
Defined in phoneNumbers.ts:97
Parameters:
Name | Type |
---|---|
phoneNumberRaw |
string |
defaultCountryCode? |
undefined | string |
Returns: ParsedPhoneNumber | null
Object literals
Const
PhoneNumberUtils
▪ PhoneNumberUtils: object
Defined in phoneNumbers.ts:240
getCountryCode
• getCountryCode: getCountryCode
Defined in phoneNumbers.ts:242
getDisplayPhoneNumber
• getDisplayPhoneNumber: getDisplayPhoneNumber
Defined in phoneNumbers.ts:244
getE164Number
• getE164Number: getE164Number
Defined in phoneNumbers.ts:245
getPhoneHash
• getPhoneHash: getPhoneHash
Defined in phoneNumbers.ts:241
getRegionCode
• getRegionCode: getRegionCode
Defined in phoneNumbers.ts:243
isE164Number
• isE164Number: isE164Number
Defined in phoneNumbers.ts:246
parsePhoneNumber
• parsePhoneNumber: parsePhoneNumber
Defined in phoneNumbers.ts:247