phone-number-generator-js

Phone number generator ·

What is phone number generator?

phone-number-generator-js a versatile JavaScript library that generates random mobile phone numbers in the E.164 format.

With this library, you can easily generate a completely random phone number or configure it to generate numbers specific to a particular country.

It supports a wide range of countries, with a total of 227 supported countries, allowing you to generate phone numbers that are valid and appropriate for various regions across the globe.

By default, if no configuration is provided, a totally random phone number will be generated from any of the 226 supported countries.

Relevant links:

• E.164 format definition
• What is E.164?
• What is the E.164 Format, and how to use it correctly

Install

npm install phone-number-generator-js

// or

yarn add phone-number-generator-js

Usage

const { generatePhoneNumber } = require("phone-number-generator-js");

// or

import { generatePhoneNumber } from "phone-number-generator-js";

1. Simple usage

generatePhoneNumber(); // '[phone]'

2. With config

Using countryName enum

generatePhoneNumber({ countryName: CountryNames.Austria }); // '[phone]'

Using withoutCountryCode flag (defaults to false)

generatePhoneNumber({
  countryName: CountryNames.Austria,
  withoutCountryCode: true,
}); // '5483746575'

Test

npm run test

// or

yarn test

Build

npm run build

// or

yarn build

Supported countries:

Countries
Afghanistan 🇦🇫	Albania 🇦🇱	Algeria 🇩🇿	American Samoa 🇦🇸
Andorra 🇦🇩	Angola 🇦🇴	Anguilla 🇦🇮	Antigua and Barbuda 🇦🇬
Argentina 🇦🇷	Armenia 🇦🇲	Aruba 🇦🇼	Australia 🇦🇺
Austria 🇦🇹	Azerbaijan 🇦🇿	Bahamas 🇧🇸	Bahrain 🇧🇭
Bangladesh 🇧🇩	Barbados 🇧🇧	Belarus 🇧🇾	Belgium 🇧🇪
Belize 🇧🇿	Benin 🇧🇯	Bermuda 🇧🇲	Bhutan 🇧🇹
Bolivia 🇧🇴	Bosnia and Herzegovina 🇧🇦	Botswana 🇧🇼	Brazil 🇧🇷
British Virgin Islands 🇻🇬	Brunei Darussalam 🇧🇳	Bulgaria 🇧🇬	Burkina Faso 🇧🇫
Burundi 🇧🇮	Cambodia 🇰🇭	Cameroon 🇨🇲	Canada 🇨🇦
Cape Verde 🇨🇻	Cayman Islands 🇰🇾	Central African Republic 🇨🇫	Chad 🇹🇩
Chile 🇨🇱	China 🇨🇳	Colombia 🇨🇴	Comoros 🇰🇲
Congo 🇨🇩	Cook Islands 🇨🇰	Costa Rica 🇨🇷	Côte D'Ivoire 🇨🇮
Croatia 🇭🇷	Cuba 🇨🇺	Curaçao 🇨🇼	Cyprus 🇨🇾
Czech Republic 🇨🇿	Democratic Republic of the Congo 🇨🇩	Denmark 🇩🇰	Djibouti 🇩🇯
Dominica 🇩🇲	Dominican Republic 🇩🇴	East Timor 🇹🇱	Ecuador 🇪🇨
Egypt 🇪🇬	El Salvador 🇸🇻	Equatorial Guinea 🇬🇶	Eritrea 🇪🇷
Estonia 🇪🇪	Eswatini 🇸🇿	Ethiopia 🇪🇹	Falkland Islands (Malvinas) 🇫🇰
Faroe Islands 🇫🇴	Fiji 🇫🇯	Finland 🇫🇮	France 🇫🇷
French Guiana 🇬🇫	French Polynesia 🇵🇫	Gabon 🇬🇦	Gambia 🇬🇲
Georgia 🇬🇪	Germany 🇩🇪	Ghana 🇬🇭	Gibraltar 🇬🇮
Greece 🇬🇷	Greenland 🇬🇱	Grenada 🇬🇩	Guadeloupe 🇬🇵
Guam 🇬🇺	Guatemala 🇬🇹	Guinea 🇬🇳	Guinea-Bissau 🇬🇼
Guyana 🇬🇾	Haiti 🇭🇹	Honduras 🇭🇳	Hong Kong 🇭🇰
Hungary 🇭🇺	Iceland 🇮🇸	India 🇮🇳	Indonesia 🇮🇩
Iran 🇮🇷	Iraq 🇮🇶	Ireland 🇮🇪	Israel 🇮🇱
Italy 🇮🇹	Jamaica 🇯🇲	Japan 🇯🇵	Jordan 🇯🇴
Kazakhstan 🇰🇿	Kenya 🇰🇪	Korea, Republic of 🇰🇷
Kuwait 🇰🇼	Kyrgyzstan 🇰🇬	Lao People's Democratic Republic 🇱🇦	Latvia 🇱🇻
Lebanon 🇱🇧	Lesotho 🇱🇸	Liberia 🇱🇷	Libya 🇱🇾
Liechtenstein 🇱🇮	Lithuania 🇱🇹	Luxembourg 🇱🇺	Macao 🇲🇴
Macedonia, the Former Yugoslav Republic Of 🇲🇰	Madagascar 🇲🇬	Malawi 🇲🇼	Malaysia 🇲🇾
Maldives 🇲🇻	Mali 🇲🇱	Malta 🇲🇹	Marshall Islands 🇲🇭
Martinique 🇲🇶	Mauritania 🇲🇷	Mauritius 🇲🇺	Mexico 🇲🇽
Micronesia, Federated States Of 🇫🇲	Moldova, Republic of 🇲🇩	Monaco 🇲🇨
Mongolia 🇲🇳	Montenegro 🇲🇪	Montserrat 🇲🇸	Morocco 🇲🇦
Mozambique 🇲🇿	Myanmar 🇲🇲	Namibia 🇳🇦	Nauru 🇳🇷
Nepal 🇳🇵	Netherlands 🇳🇱	New Caledonia 🇳🇨	New Zealand 🇳🇿
Nicaragua 🇳🇮	Niger 🇳🇪	Nigeria 🇳🇬	Niue 🇳🇺
Norfolk Island 🇳🇫	Northern Mariana Islands 🇲🇵	Norway 🇳🇴	Oman 🇴🇲
Pakistan 🇵🇰	Palau 🇵🇼	Panama 🇵🇦	Papua New Guinea 🇵🇬
Paraguay 🇵🇾	Peru 🇵🇪	Philippines 🇵🇭	Pitcairn 🇵🇳
Poland 🇵🇱	Portugal 🇵🇹	Puerto Rico 🇵🇷	Qatar 🇶🇦
Réunion 🇷🇪	Romania 🇷🇴	Russian Federation 🇷🇺	Rwanda 🇷🇼
Saint Helena 🇸🇭	Saint Kitts And Nevis 🇰🇳	Saint Lucia 🇱🇨	Saint Pierre And Miquelon 🇵🇲
Saint Vincent And The Grenedines 🇻🇨	Samoa 🇼🇸	San Marino 🇸🇲	Sao Tome and Principe 🇸🇹
Saudi Arabia 🇸🇦	Senegal 🇸🇳	Serbia 🇷🇸	Seychelles 🇸🇨
Sierra Leone 🇸🇱	Singapore 🇸🇬	Sint Maarten 🇸🇽	Slovakia 🇸🇰
Slovenia 🇸🇮	Solomon Islands 🇸🇧	Somalia 🇸🇴	South Africa 🇿🇦
South Sudan 🇸🇸	Spain 🇪🇸	Sri Lanka 🇱🇰	Sudan 🇸🇩
Suriname 🇸🇷	Sweden 🇸🇪	Switzerland 🇨🇭	Syrian Arab Republic 🇸🇾
Taiwan 🇹🇼	Tajikistan 🇹🇯	Tanzania, United Republic of 🇹🇿	Thailand 🇹🇭
Timor-Leste 🇹🇱	Togo 🇹🇬	Tokelau 🇹🇰	Tonga 🇹🇴
Trinidad and Tobago 🇹🇹	Tunisia 🇹🇳	Turkey 🇹🇷	Turkmenistan 🇹🇲
Turks and Caicos Islands 🇹🇨	Tuvalu 🇹🇻	Uganda 🇺🇬	Ukraine 🇺🇦
United Arab Emirates 🇦🇪	United Kingdom 🇬🇧	United States 🇺🇸	Uruguay 🇺🇾
Uzbekistan 🇺🇿	Vanuatu 🇻🇺	Vietnam 🇻🇳	Yemen 🇾🇪
Virgin Islands, British 🇻🇬	Virgin Islands, U.S. 🇻🇮	Wallis and Futuna 🇼🇫
Zambia 🇿🇲	Zimbabwe 🇿🇼

Credits

1. Validating that the generated phone number is valid & following the E.164 format - libphonenumber-js
2. Countries phone number data (country code, mobile starting digits & length) - phone