cl

country-list

Maps ISO 3166-1-alpha-2 codes to English country names and vice versa.

Showing:

Popularity

Downloads/wk

103K

GitHub Stars

199

Maintenance

Last Commit

2yrs ago

Contributors

5

Package

Dependencies

0

Size (min+gzip)

2.8KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Readme

country-list

Build Status Coverage Status

Maps ISO 3166-1-alpha-2 codes to English country names and vice versa.

Uses data from https://www.iso.org/iso-3166-country-codes.html

js-standard-style

Looking for Version 1

You can find version 1.* of country-list here.

Example

const { getCode, getName } = require('country-list');

console.log(getName('IS')); // Iceland
console.log(getCode('Iceland')); // IS
console.log(getCode('Nowhere-to-be-found-land')); // undefined

And how to change the name of a country

const { overwrite, getName } = require('country-list');
overwrite([{
  code: 'TW',
  name: 'Taiwan'
}])

console.log(getName('TW')); // Taiwan

Methods

Usage:

const countryList = require('country-list');

All input is case-insensitive.

overwrite(countries)

Expects an array of country objects containing code and name properties.

[{
  code: 'TW',
  name: 'Taiwan'
}]

getName(code)

Expects a two-digit country code.
Returns the name for that country.
If not found, it returns undefined.

getCode(name)

Expects the English country name.
Returns the code for that country.
If not found, it returns undefined.

getNames()

Returns an array of all country names.

getCodes()

Returns an array of all country codes.

getNameList()

Returns a key-value object of all countries using the name as key.

getCodeList()

Returns a key-value object of all countries using the code as key.

getData()

Returns an array of all country information, in the same format as it gets imported.

Install

npm install country-list

License

MIT

Source

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Tutorials

No tutorials found
Add a tutorial