JSPM

  • Created
  • Published
  • Downloads 1194091
  • Score
    100M100P100Q204942F
  • License MIT

i18n for ISO 3166-1 country codes

Package Exports

  • i18n-iso-countries
  • i18n-iso-countries/codes.json
  • i18n-iso-countries/index
  • i18n-iso-countries/langs/ar.json
  • i18n-iso-countries/langs/az.json
  • i18n-iso-countries/langs/be.json
  • i18n-iso-countries/langs/bg.json
  • i18n-iso-countries/langs/bn.json
  • i18n-iso-countries/langs/bs.json
  • i18n-iso-countries/langs/ca.json
  • i18n-iso-countries/langs/cs.json
  • i18n-iso-countries/langs/da.json
  • i18n-iso-countries/langs/de.json
  • i18n-iso-countries/langs/el.json
  • i18n-iso-countries/langs/en
  • i18n-iso-countries/langs/en.json
  • i18n-iso-countries/langs/es.json
  • i18n-iso-countries/langs/et.json
  • i18n-iso-countries/langs/fa.json
  • i18n-iso-countries/langs/fi.json
  • i18n-iso-countries/langs/fr.json
  • i18n-iso-countries/langs/gl.json
  • i18n-iso-countries/langs/he.json
  • i18n-iso-countries/langs/hi.json
  • i18n-iso-countries/langs/hr.json
  • i18n-iso-countries/langs/hu.json
  • i18n-iso-countries/langs/hy.json
  • i18n-iso-countries/langs/id.json
  • i18n-iso-countries/langs/it.json
  • i18n-iso-countries/langs/ja.json
  • i18n-iso-countries/langs/ka.json
  • i18n-iso-countries/langs/kk.json
  • i18n-iso-countries/langs/ko.json
  • i18n-iso-countries/langs/ky.json
  • i18n-iso-countries/langs/lt.json
  • i18n-iso-countries/langs/lv.json
  • i18n-iso-countries/langs/mk.json
  • i18n-iso-countries/langs/mn.json
  • i18n-iso-countries/langs/ms.json
  • i18n-iso-countries/langs/nb.json
  • i18n-iso-countries/langs/nl.json
  • i18n-iso-countries/langs/nn.json
  • i18n-iso-countries/langs/pl.json
  • i18n-iso-countries/langs/pt.json
  • i18n-iso-countries/langs/ro.json
  • i18n-iso-countries/langs/ru.json
  • i18n-iso-countries/langs/sk.json
  • i18n-iso-countries/langs/sl.json
  • i18n-iso-countries/langs/sr.json
  • i18n-iso-countries/langs/sv.json
  • i18n-iso-countries/langs/th.json
  • i18n-iso-countries/langs/tr.json
  • i18n-iso-countries/langs/uk.json
  • i18n-iso-countries/langs/ur.json
  • i18n-iso-countries/langs/uz.json
  • i18n-iso-countries/langs/vi.json
  • i18n-iso-countries/langs/zh.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (i18n-iso-countries) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Build Status NPM version

i18n-iso-countries

⚠️ Version 5 drops support for node 6 and 7!

i18n for ISO 3166-1 country codes. We support Alpha-2, Alpha-3 and Numeric codes from 'Wikipedia: Officially assigned code elements'

Installing

Install it using npm: npm install i18n-iso-countries

var countries = require("i18n-iso-countries");

If you use i18n-iso-countries with Node.js, you are done. If you use the package in a browser environment, you have to register the languages you want to use to minimize the file size.

// Support french & english languages.
countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
countries.registerLocale(require("i18n-iso-countries/langs/fr.json"));

Code to Country

Get the name of a country by its ISO 3166-1 Alpha-2, Alpha-3 or Numeric code

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log("US (Alpha-2) => " + countries.getName("US", "en", {select: "official"})); // United States of America
console.log("US (Alpha-2) => " + countries.getName("US", "de", {select: "official"})); // Vereinigte Staaten von Amerika
console.log("USA (Alpha-3) => " + countries.getName("USA", "en", {select: "official"})); // United States of America
console.log("USA (Numeric) => " + countries.getName("840", "en", {select: "official"})); // United States of America

Get all names by their ISO 3166-1 Alpha-2 code

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log(countries.getNames("en", {select: "official"})); // { 'AF': 'Afghanistan', 'AL': 'Albania', [...], 'ZM': 'Zambia', 'ZW': 'Zimbabwe' }

Supported languages (ISO 639-1)

In case you want to add new language, please refer ISO 639-1 table.

  • af: Afrikaans
  • am: Amharic
  • ar: Arabic
  • az: Azerbaijani
  • be: Belorussian
  • bg: Bulgarian
  • bn: Bengali
  • bs: Bosnian
  • ca: Catalan
  • cs: Czech
  • cy: Cymraeg
  • da: Danish
  • de: German
  • dv: Dhivehi
  • en: English
  • es: Spanish
  • et: Estonian
  • eu: Basque
  • fa: Persian
  • fi: Finnish
  • fr: French
  • gl: Galician
  • el: Greek
  • ha: Hausa
  • he: Hebrew
  • hi: Hindi
  • hr: Croatian
  • hu: Hungarian
  • hy: Armenian
  • is: Icelandic
  • it: Italian
  • id: Indonesian
  • ja: Japanese
  • ka: Georgian
  • kk: Kazakh
  • km: Khmer
  • ko: Korean
  • ku: Kurdish
  • ky: Kyrgyz
  • lt: Lithuanian
  • lv: Latvian
  • mk: Macedonian
  • ml: Malayalam
  • mn: Mongolian
  • ms: Malay
  • nb: Norwegian Bokmål
  • nl: Dutch
  • nn: Norwegian Nynorsk
  • no: Norwegian
  • pl: Polish
  • ps: Pashto
  • pt: Portuguese
  • ro: Romanian
  • ru: Russian
  • sd: Sindhi
  • sk: Slovak
  • sl: Slovene
  • so: Somali
  • sq: Albanian
  • sr: Serbian
  • sv: Swedish
  • sw: Swahili
  • ta: Tamil
  • tg: Tajik
  • th: Thai
  • tr: Turkish
  • tt: Tatar
  • ug: Uyghur
  • uk: Ukrainian
  • ur: Urdu
  • uz: Uzbek
  • zh: Chinese
  • vi: Vietnamese

List of ISO 639-1 codes

Country to Code

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log(
  "United States of America => " +
    countries.getAlpha2Code("United States of America", "en")
);
// United States of America => US

console.log(
  "United States of America => " +
    countries.getAlpha3Code("United States of America", "en")
);
// United States of America => USA

Codes

Convert Alpha-3 to Alpha-2 code

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log(
  "USA (Alpha-3) => " + countries.alpha3ToAlpha2("USA") + " (Alpha-2)"
);
// USA (Alpha-3) => US (Alpha-2)

Convert Numeric to Alpha-2 code

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log(
  "840 (Numeric) => " + countries.numericToAlpha2("840") + " (Alpha-2)"
);
// 840 (Numeric) => US (Alpha-2)

Convert Alpha-2 to Alpha-3 code

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log("DE (Alpha-2) => " + countries.alpha2ToAlpha3("DE") + " (Alpha-3)");
// DE (Alpha-2) => DEU (Alpha-3)

Convert Numeric to Alpha-3 code

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log(
  "840 (Numeric) => " + countries.numericToAlpha3("840") + " (Alpha-3)"
);
// 840 (Numeric) => USA (Alpha-3)

Convert Alpha-3 to Numeric code

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log(countries.alpha3ToNumeric("SWE"));
// 752

Convert Alpha-2 to Numeric code

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log(countries.alpha2ToNumeric("SE"));
// 752

Get all Alpha-2 codes

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log(countries.getAlpha2Codes());
// { 'AF': 'AFG', 'AX': 'ALA', [...], 'ZM': 'ZMB', 'ZW': 'ZWE' }

Get all Alpha-3 codes

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log(countries.getAlpha3Codes());
// { 'AFG': 'AF', 'ALA': 'AX', [...], 'ZMB': 'ZM', 'ZWE': 'ZW' }

Get all Numeric codes

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log(countries.getNumericCodes());
// { '004': 'AF', '008': 'AL', [...], '887': 'YE', '894': 'ZM' }

Validate country code

var countries = require("i18n-iso-countries");
// in a browser environment: countries.registerLocale(require("i18n-iso-countries/langs/en.json"));
console.log(
  countries.isValid("US"),
  countries.isValid("USA"),
  countries.isValid("XX")
);
// true, true, false

Contribution

To add a language:

  • add a json file under langs/
  • add the language to the data object in entry-node.js at the top
  • add language to section Supported languages in README.md
  • add language to keywords in package.json
  • run npm test to make sure that tests are passing
  • open a PR on GitHub

You can check codes here: https://www.iso.org/obp/ui/#home