Country Locale Map

Provides easy conversion between country codes and names as well as a default locale for each country. Includes fuzzy matching for country name lookups. Methods return undefined if no matches are found

Usage

1const clm = require('country-locale-map');
2clm.getAlpha3ByAlpha2('CA'); //returns 'CAN' 

If you would like locales to be returned with - instead of_ you can set an environment variable

CLM_MODE='INTL' in a .env file using dotenv just make sure that dotenv is required before requiring the country local map library

Functions

Alpha2

• getAlpha3ByAlpha2(alpha2)

1clm.getAlpha3ByAlpha2('CA'); //returns 'CAN' 

• getLocaleByAlpha2(alpha2)

1clm.getLocaleByAlpha2('CA'); //returns 'en_CA' 

• getCountryNameByAlpha2(alpha2)

1clm.getCountryNameByAlpha2('CA'); //returns 'Canada' 

• getNumericByAlpha2(alpha2)

1clm.getNumericByAlpha2('CA'); //returns '124' 

• getCurrencyByAlpha2(alpha2)

1clm.getCurrencyByAlpha2('CA'); //returns 'CAD' 

• getCountryByAlpha2(alpha2)

1clm.getCountryByAlpha2('CA'); 
2
3/*returns 
4
5    {
6        "name":"Canada",
7        "alpha2":"CA",
8        "alpha3":"CAN",
9        "numeric":"124",
10        "locales":["en_CA","fr_CA"],
11        "default_locale":"en_CA",
12        "currency":"CAD",
13        "languages":["en","fr"],
14        "capital":"Ottawa",
15        "emoji":"🇨🇦",
16        "emojiU":"U+1F1E8 U+1F1E6",
17        "fips":"CA",
18        "internet":"CA",
19        "continent":"Americas",
20        "region":"North America"
21    }
22
23*/

Alpha3

• getAlpha2ByAlpha3(alpha3)

1clm.getAlpha3ByAlpha2('CAN'); //returns 'CA' 

• getLocaleByAlpha3(alpha3)

1clm.getLocaleByAlpha3('CAN'); //returns 'en_CA' 

• getCountryNameByAlpha3(alpha3)

1clm.getCountryNameByAlpha3('CAN'); //returns 'Canada' 

• getNumericByAlpha3(alpha3)

1clm.getNumericByAlpha3('CAN'); //returns '124' 

• getCurrencyByAlpha3(alpha3)

1clm.getCurrencyByAlpha3('CAN'); //returns 'CAD' 

• getCountryByAlpha3(alpha3)

1clm.getCountryByAlpha3('CAN');
2
3
4/*returns 
5
6    {
7        "name":"Canada",
8        "alpha2":"CA",
9        "alpha3":"CAN",
10        "numeric":"124",
11        "locales":["en_CA","fr_CA"],
12        "default_locale":"en_CA",
13        "currency":"CAD",
14        "languages":["en","fr"],
15        "capital":"Ottawa",
16        "emoji":"🇨🇦",
17        "emojiU":"U+1F1E8 U+1F1E6",
18        "fips":"CA",
19        "internet":"CA",
20        "continent":"Americas",
21        "region":"North America"
22    }
23
24*/
25

Numeric

• getAlpha2ByNumeric(numeric)

1clm.getAlpha2ByNumeric('123'); //returns 'CA' 

• getAlpha3ByNumeric(numeric)

1clm.getAlpha3ByNumeric('124'); //returns 'CAN' 

• getLocaleByNumeric(numeric)

1clm.getLocaleByNumeric('124'); //returns 'en_CA' 

• getCountryNameByNumeric(numeric)

1clm.getCountryNameByNumeric('124'); //returns 'Canada' 

• getCurrencyByNumeric(numeric)

1clm.getCurrencyByNumeric('124'); //returns 'CAD' 

• getCountryByNumeric(numeric)

1clm.getCountryByNumeric('124');
2
3
4/*returns 
5
6    {
7        "name":"Canada",
8        "alpha2":"CA",
9        "alpha3":"CAN",
10        "numeric":"124",
11        "locales":["en_CA","fr_CA"],
12        "default_locale":"en_CA",
13        "currency":"CAD",
14        "languages":["en","fr"],
15        "capital":"Ottawa",
16        "emoji":"🇨🇦",
17        "emojiU":"U+1F1E8 U+1F1E6",
18        "fips":"CA",
19        "internet":"CA",
20        "continent":"Americas",
21        "region":"North America"
22    }
23
24*/
25
26

Name

• getAlpha2ByName(country, fuzzy)

1clm.getAlpha2ByName('Canada'); //returns 'CA' 

• getAlpha3ByName(country, fuzzy)

1clm.getAlpha3ByName('Canada'); //returns 'CAN' 

• getLocaleByName(country, fuzzy)

1clm.getLocaleByName('Canada'); //returns 'en_CA' 

• getNumericByName(country, fuzzy)

1clm.getNumericByName('Canada'); //returns '124' 

• getCurrencyByName(country, fuzzy)

1clm.getCurrencyByName('Canada'); //returns 'CAD' 

• getCountryByName(country, fuzzy)

1clm.getCountryByName('Canada');
2
3/*returns 
4
5    {
6        "name":"Canada",
7        "alpha2":"CA",
8        "alpha3":"CAN",
9        "numeric":"124",
10        "locales":["en_CA","fr_CA"],
11        "default_locale":"en_CA",
12        "currency":"CAD",
13        "languages":["en","fr"],
14        "capital":"Ottawa",
15        "emoji":"🇨🇦",
16        "emojiU":"U+1F1E8 U+1F1E6",
17        "fips":"CA",
18        "internet":"CA",
19        "continent":"Americas",
20        "region":"North America"
21    }
22
23*/
24

if true is passed for fuzzy these functions will do a fuzzy match if it can't find an exact match eg:

1clm.getCountryByName('Candaa', true);
2
3/*returns 
4
5    {
6        "name":"Canada",
7        "alpha2":"CA",
8        "alpha3":"CAN",
9        "numeric":"124",
10        "locales":["en_CA","fr_CA"],
11        "default_locale":"en_CA",
12        "currency":"CAD",
13        "languages":["en","fr"],
14        "capital":"Ottawa",
15        "emoji":"🇨🇦",
16        "emojiU":"U+1F1E8 U+1F1E6",
17        "fips":"CA",
18        "internet":"CA",
19        "continent":"Americas",
20        "region":"North America"
21    }
22
23*/
24

• getAllCountries()

1clm.getAllCountries();
2
3/*returns 
4    the list of all countries 
5*/
6