@celo/utils › "packages/sdk/utils/src/phoneNumbers"

Module: "packages/sdk/utils/src/phoneNumbers"

Index

References

• ParsedPhoneNumber
• anonymizedPhone
• isE164Number

Functions

• getCountryCode
• getCountryEmoji
• getDisplayNumberInternational
• getDisplayPhoneNumber
• getE164DisplayNumber
• getE164Number
• getExampleNumber
• getPhoneHash
• getRegionCode
• getRegionCodeFromCountryCode
• isE164NumberStrict
• parsePhoneNumber

Object literals

• PhoneNumberUtils

References

ParsedPhoneNumber

• ParsedPhoneNumber:

---

anonymizedPhone

• anonymizedPhone:

---

isE164Number

• isE164Number:

Functions

getCountryCode

▸ getCountryCode(e164PhoneNumber: string): undefined | null | number

Defined in packages/sdk/utils/src/phoneNumbers.ts:54

deprecated moved to @celo/phone-utils will be removed in next major version

Parameters:

Name	Type
e164PhoneNumber	string

Returns: undefined | null | number

---

getCountryEmoji

▸ getCountryEmoji(e164PhoneNumber: string, countryCodePossible?: undefined | number, regionCodePossible?: undefined | string): string

Defined in packages/sdk/utils/src/phoneNumbers.ts:31

deprecated moved to @celo/phone-utils will be removed in next major version

Parameters:

Name	Type
e164PhoneNumber	string
countryCodePossible?	undefined | number
regionCodePossible?	undefined | string

Returns: string

---

getDisplayNumberInternational

▸ getDisplayNumberInternational(e164PhoneNumber: string): string

Defined in packages/sdk/utils/src/phoneNumbers.ts:110

deprecated moved to @celo/phone-utils will be removed in next major version

Parameters:

Name	Type
e164PhoneNumber	string

Returns: string

---

getDisplayPhoneNumber

▸ getDisplayPhoneNumber(phoneNumber: string, defaultCountryCode: string): string

Defined in packages/sdk/utils/src/phoneNumbers.ts:97

deprecated moved to @celo/phone-utils will be removed in next major version

Parameters:

Name	Type
phoneNumber	string
defaultCountryCode	string

Returns: string

---

getE164DisplayNumber

▸ getE164DisplayNumber(e164PhoneNumber: string): string

Defined in packages/sdk/utils/src/phoneNumbers.ts:124

deprecated moved to @celo/phone-utils will be removed in next major version

Parameters:

Name	Type
e164PhoneNumber	string

Returns: string

---

getE164Number

▸ getE164Number(phoneNumber: string, defaultCountryCode: string): null | string

Defined in packages/sdk/utils/src/phoneNumbers.ts:132

deprecated moved to @celo/phone-utils will be removed in next major version

Parameters:

Name	Type
phoneNumber	string
defaultCountryCode	string

Returns: null | string

---

getExampleNumber

▸ getExampleNumber(regionCode: string, useOnlyZeroes: boolean, isInternational: boolean): undefined | string

Defined in packages/sdk/utils/src/phoneNumbers.ts:283

deprecated moved to @celo/phone-utils will be removed in next major version

Parameters:

Name	Type	Default
regionCode	string	-
useOnlyZeroes	boolean	true
isInternational	boolean	false

Returns: undefined | string

---

Const getPhoneHash

▸ getPhoneHash(phoneNumber: string, salt?: undefined | string): string

Defined in packages/sdk/utils/src/phoneNumbers.ts:21

Parameters:

Name	Type
phoneNumber	string
salt?	undefined | string

Returns: string

---

getRegionCode

▸ getRegionCode(e164PhoneNumber: string): undefined | null | string

Defined in packages/sdk/utils/src/phoneNumbers.ts:68

deprecated moved to @celo/phone-utils will be removed in next major version

Parameters:

Name	Type
e164PhoneNumber	string

Returns: undefined | null | string

---

getRegionCodeFromCountryCode

▸ getRegionCodeFromCountryCode(countryCode: string): null | string

Defined in packages/sdk/utils/src/phoneNumbers.ts:82

deprecated moved to @celo/phone-utils will be removed in next major version

Parameters:

Name	Type
countryCode	string

Returns: null | string

---

isE164NumberStrict

▸ isE164NumberStrict(phoneNumber: string): boolean

Defined in packages/sdk/utils/src/phoneNumbers.ts:145

deprecated moved to @celo/phone-utils will be removed in next major version

Parameters:

Name	Type
phoneNumber	string

Returns: boolean

---

parsePhoneNumber

▸ parsePhoneNumber(phoneNumberRaw: string, defaultCountryCode?: undefined | string): ParsedPhoneNumber | null

Defined in packages/sdk/utils/src/phoneNumbers.ts:160

deprecated moved to @celo/phone-utils will be removed in next major version

Parameters:

Name	Type
phoneNumberRaw	string
defaultCountryCode?	undefined | string

Returns: ParsedPhoneNumber | null

Object literals

Const PhoneNumberUtils

▪ PhoneNumberUtils: object

Defined in packages/sdk/utils/src/phoneNumbers.ts:311

getCountryCode

• getCountryCode: getCountryCode

Defined in packages/sdk/utils/src/phoneNumbers.ts:313

getDisplayPhoneNumber

• getDisplayPhoneNumber: getDisplayPhoneNumber

Defined in packages/sdk/utils/src/phoneNumbers.ts:315

getE164Number

• getE164Number: getE164Number

Defined in packages/sdk/utils/src/phoneNumbers.ts:316

getPhoneHash

• getPhoneHash: getPhoneHash

Defined in packages/sdk/utils/src/phoneNumbers.ts:312

getRegionCode

• getRegionCode: getRegionCode

Defined in packages/sdk/utils/src/phoneNumbers.ts:314

isE164Number

• isE164Number: isE164Number

Defined in packages/sdk/utils/src/phoneNumbers.ts:317

parsePhoneNumber

• parsePhoneNumber: parsePhoneNumber

Defined in packages/sdk/utils/src/phoneNumbers.ts:318