{"_id":"@shellscape/i18n-iso-countries","name":"@shellscape/i18n-iso-countries","dist-tags":{"latest":"7.5.0-shellscape.v1"},"versions":{"7.5.0-shellscape.v1":{"name":"@shellscape/i18n-iso-countries","version":"7.5.0-shellscape.v1","description":"i18n for ISO 3166-1 country codes","types":"types/index.d.ts","publishConfig":{"access":"public"},"keywords":["i18n","iso","3166","iso 3166","iso 3166-1","alpha","alpha-2","alpha-3","numeric","country","countries","af","am","ar","az","be","bg","bn","br","bs","ca","cs","cy","da","de","dv","el","en","es","et","eu","fa","fi","fr","gl","ha","he","hi","hr","hu","hy","id","is","it","ja","ka","kk","km","ko","ku","ky","lt","lv","mk","ml","mn","mr","ms","nb","nl","nn","no","pl","ps","pt","ro","ru","sd","sk","sl","so","sq","sr","sv","sw","ta","tg","th","tk","tr","tt","uk","ug","ur","uz","vi","zh"],"author":{"name":"Andreas Wittig","email":"me@andreaswittig.info"},"contributors":[{"name":"Michael Wittig","email":"post@shellscape.info"},{"name":"Bedis ElAcheche","email":"d4rk-5c0rp@ubuntu.com"},{"name":"Johann Behr","email":"behr@oak-labs.com"},{"name":"Omkar Tapale","email":"omkartapale@gmail.com"},{"name":"Alexis Launay","email":"yorunohikage@gmail.com"}],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/shellscape/node-i18n-iso-countries.git"},"dependencies":{"diacritics":"1.3.0"},"devDependencies":{"eslint":"8.3.0","eslint-config-prettier":"8.3.0","eslint-plugin-prettier":"4.0.0","mocha":"9.1.3","prettier":"2.4.1"},"main":"lib/index.js","browser":"lib/index.js","engines":{"node":">= 16"},"scripts":{"test":"mocha test/*.js","lint":"eslint **/*.js"},"bugs":{"url":"https://github.com/shellscape/node-i18n-iso-countries/issues"},"gitHead":"767afc2250a359d4b53e15d861cf180b1a76a874","homepage":"https://github.com/shellscape/node-i18n-iso-countries#readme","_id":"@shellscape/i18n-iso-countries@7.5.0-shellscape.v1","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-FB7Grjo2ciFWcU6mNl3rf0xRnUnjzu3NlEOMOg9dhrsRm18WMOpWkHbwL21+HXnAVjsxIn8l3MnkiAz/LdmPiQ==","shasum":"c1017df8b240a9992a0ea1f78c5a021d4fbcbb82","tarball":"https://registry.npmjs.org/@shellscape/i18n-iso-countries/-/i18n-iso-countries-7.5.0-shellscape.v1.tgz","fileCount":83,"unpackedSize":599555,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDSM2no64FOYOnVPtmF/yTEsRB5L7Q8rkvsKBlimtjeaQIhAI5KMrubRb7msO3iL4aFGaitBTieS3Vx+NEHxQsdP9La"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj4TpLACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmoxyg/8CH9PnduBobzM3yL0hDxmOjO3hZct6xMafJthsK0ZMp3XLH0M\r\nS6CwXJw6uDDZTQeS9pJ3CGlezhTPkma4M9ew4gXKeAEypho4NfeMX5752GI6\r\nGYWnrwvTJd+JbBur8Qw8SBlQKhOD3GfoKvgUth3Wxout7NLFtvUmtSjBoWfK\r\n1d1kNVFcLAJ6KGZsiRasZfTDPLyPl4amO3aXgj7v2Ev0kjkGIlRYU5/whj7L\r\nPhTXuzRGruXW8OMrwM/R4gCMKaoHTTQkXr70/oqtGancFp5R9ArBvGmuKE4X\r\nQ6F1+w4+kIElDe6gvzKevPM0Twt7sGpbzsWWcnpLlPECufInwm5SzUzM6W/8\r\nwkUn4RLKO86lpCITXFBLsO1Dnt6foAHENcaPOQZvp7eIl/BLLtxeZULiNp4N\r\noCz+TnuwUQegkhzgqqLw9af+JAwepLy+ShbxrIZMRo7JArQ4tZLKTTZIMRrY\r\nnqoXDzAca9I4FJ4ZoaxGhxRVy6xAnCrhJKjx8eC4f3s9/2gHRPxgH0qhTZOV\r\nuE27Kp6llc70taOMzwh3RII3EOuxUXN56DZ+sTJZG50JJw6yc+0tV4mo4vKe\r\nd7Pvut/6RsYRkrHOEXRrmGCeUjTPleNrOnL2clhy32kJyzE/aeDaymO4/Xqr\r\nEEOsc2h1mfYI7mgp8vER/2Fro2hTR4n6azs=\r\n=sOJd\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"shellscape","email":"andrew@shellscape.org"},"directories":{},"maintainers":[{"name":"shellscape","email":"andrew@shellscape.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/i18n-iso-countries_7.5.0-shellscape.v1_1675704906870_0.7583262333954484"},"_hasShrinkwrap":false}},"time":{"created":"2023-02-06T17:35:06.814Z","7.5.0-shellscape.v1":"2023-02-06T17:35:07.096Z","modified":"2023-02-06T17:35:07.256Z"},"maintainers":[{"name":"shellscape","email":"andrew@shellscape.org"}],"description":"i18n for ISO 3166-1 country codes","homepage":"https://github.com/shellscape/node-i18n-iso-countries#readme","keywords":["i18n","iso","3166","iso 3166","iso 3166-1","alpha","alpha-2","alpha-3","numeric","country","countries","af","am","ar","az","be","bg","bn","br","bs","ca","cs","cy","da","de","dv","el","en","es","et","eu","fa","fi","fr","gl","ha","he","hi","hr","hu","hy","id","is","it","ja","ka","kk","km","ko","ku","ky","lt","lv","mk","ml","mn","mr","ms","nb","nl","nn","no","pl","ps","pt","ro","ru","sd","sk","sl","so","sq","sr","sv","sw","ta","tg","th","tk","tr","tt","uk","ug","ur","uz","vi","zh"],"repository":{"type":"git","url":"git+https://github.com/shellscape/node-i18n-iso-countries.git"},"contributors":[{"name":"Michael Wittig","email":"post@shellscape.info"},{"name":"Bedis ElAcheche","email":"d4rk-5c0rp@ubuntu.com"},{"name":"Johann Behr","email":"behr@oak-labs.com"},{"name":"Omkar Tapale","email":"omkartapale@gmail.com"},{"name":"Alexis Launay","email":"yorunohikage@gmail.com"}],"author":{"name":"Andreas Wittig","email":"me@andreaswittig.info"},"bugs":{"url":"https://github.com/shellscape/node-i18n-iso-countries/issues"},"license":"MIT","readme":"# i18n-iso-countries\n\ni18n for ISO 3166-1 country codes. We support Alpha-2, Alpha-3 and Numeric codes from ['Wikipedia: Officially assigned code elements'][iso:3166-1]\n\n## Installing\n\nInstall it using npm: `npm install i18n-iso-countries`\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n```\n\nIf 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.\n\n```javascript\n// Support french & english languages.\ncountries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\ncountries.registerLocale(require(\"i18n-iso-countries/langs/fr.json\"));\n```\n\n## Code to Country\n\n### Get the name of a country by its ISO 3166-1 Alpha-2, Alpha-3 or Numeric code\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(\"US (Alpha-2) => \" + countries.getName(\"US\", \"en\")); // United States of America\nconsole.log(\"US (Alpha-2) => \" + countries.getName(\"US\", \"de\")); // Vereinigte Staaten von Amerika\nconsole.log(\"USA (Alpha-3) => \" + countries.getName(\"USA\", \"en\")); // United States of America\nconsole.log(\"USA (Numeric) => \" + countries.getName(\"840\", \"en\")); // United States of America\n```\n\n#### Get aliases/short name using select\n\n```javascript\n// Some countries have alias/short names defined. `select` is used to control which\n// name will be returned.\nconsole.log(\"GB (select: official) => \" + countries.getName(\"GB\", \"en\", {select: \"official\"})); // United Kingdom\nconsole.log(\"GB (select: alias) => \" + countries.getName(\"GB\", \"en\", {select: \"alias\"})); // UK\nconsole.log(\"GB (select: all) => \" + countries.getName(\"GB\", \"en\", {select: \"all\"})); // [\"United Kingdom\", \"UK\", \"Great Britain\"]\n// Countries without an alias will always return the offical name\nconsole.log(\"LT (select: official) => \" + countries.getName(\"LT\", \"en\", {select: \"official\"})); // Lithuania\nconsole.log(\"LT (select: alias) => \" + countries.getName(\"LT\", \"en\", {select: \"alias\"})); // Lithuania\nconsole.log(\"LT (select: all) => \" + countries.getName(\"LT\", \"en\", {select: \"all\"})); // [\"Lithuania\"]\n```\n\n### Get all names by their ISO 3166-1 Alpha-2 code\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(countries.getNames(\"en\", {select: \"official\"})); // { 'AF': 'Afghanistan', 'AL': 'Albania', [...], 'ZM': 'Zambia', 'ZW': 'Zimbabwe' }\n```\n\n### Supported languages (ISO 639-1)\n\n> In case you want to add new language, please refer [ISO 639-1 table][iso:639-1].\n\n- `af`: Afrikaans\n- `am`: Amharic\n- `ar`: Arabic\n- `az`: Azerbaijani\n- `be`: Belorussian\n- `bg`: Bulgarian\n- `bn`: Bengali\n- `br`: Breton\n- `bs`: Bosnian\n- `ca`: Catalan\n- `cs`: Czech\n- `cy`: Cymraeg\n- `da`: Danish\n- `de`: German\n- `dv`: Dhivehi\n- `en`: English\n- `es`: Spanish\n- `et`: Estonian\n- `eu`: Basque\n- `fa`: Persian\n- `fi`: Finnish\n- `fr`: French\n- `gl`: Galician\n- `el`: Greek\n- `ha`: Hausa\n- `he`: Hebrew\n- `hi`: Hindi\n- `hr`: Croatian\n- `hu`: Hungarian\n- `hy`: Armenian\n- `is`: Icelandic\n- `it`: Italian\n- `id`: Indonesian\n- `ja`: Japanese\n- `ka`: Georgian\n- `kk`: Kazakh\n- `km`: Khmer\n- `ko`: Korean\n- `ku`: Kurdish\n- `ky`: Kyrgyz\n- `lt`: Lithuanian\n- `lv`: Latvian\n- `mk`: Macedonian\n- `ml`: Malayalam\n- `mn`: Mongolian\n- `mr`: Marathi\n- `ms`: Malay\n- `nb`: Norwegian Bokmål\n- `nl`: Dutch\n- `nn`: Norwegian Nynorsk\n- `no`: Norwegian\n- `pl`: Polish\n- `ps`: Pashto\n- `pt`: Portuguese\n- `ro`: Romanian\n- `ru`: Russian\n- `sd`: Sindhi\n- `sk`: Slovak\n- `sl`: Slovene\n- `so`: Somali\n- `sq`: Albanian\n- `sr`: Serbian\n- `sv`: Swedish\n- `sw`: Swahili\n- `ta`: Tamil\n- `tg`: Tajik\n- `th`: Thai\n- `tr`: Turkish\n- `tt`: Tatar\n- `ug`: Uyghur\n- `uk`: Ukrainian\n- `ur`: Urdu\n- `uz`: Uzbek\n- `zh`: Chinese\n- `vi`: Vietnamese\n\n[List of ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)\n\n### Get all supported languages (ISO 639-1)\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\nconsole.log(\"List of supported languages => \" + countries.getSupportedLanguages());\n// List of supported languages => [\"cy\", \"dv\", \"sw\", \"eu\", \"af\", \"am\", ...]\n```\n\n### Country to Code\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(\"United States of America => \" + countries.getAlpha2Code(\"United States of America\", \"en\"));\n// United States of America => US\n\nconsole.log(\"United States of America => \" + countries.getAlpha3Code(\"United States of America\", \"en\"));\n// United States of America => USA\n```\n\n## Codes\n\n### Convert Alpha-3 to Alpha-2 code\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(\"USA (Alpha-3) => \" + countries.alpha3ToAlpha2(\"USA\") + \" (Alpha-2)\");\n// USA (Alpha-3) => US (Alpha-2)\n```\n\n### Convert Numeric to Alpha-2 code\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(\"840 (Numeric) => \" + countries.numericToAlpha2(\"840\") + \" (Alpha-2)\");\n// 840 (Numeric) => US (Alpha-2)\n```\n\n### Convert Alpha-2 to Alpha-3 code\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(\"DE (Alpha-2) => \" + countries.alpha2ToAlpha3(\"DE\") + \" (Alpha-3)\");\n// DE (Alpha-2) => DEU (Alpha-3)\n```\n\n### Convert Numeric to Alpha-3 code\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(\"840 (Numeric) => \" + countries.numericToAlpha3(\"840\") + \" (Alpha-3)\");\n// 840 (Numeric) => USA (Alpha-3)\n```\n\n### Convert Alpha-3 to Numeric code\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(countries.alpha3ToNumeric(\"SWE\"));\n// 752\n```\n\n### Convert Alpha-2 to Numeric code\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(countries.alpha2ToNumeric(\"SE\"));\n// 752\n```\n\n### Get all Alpha-2 codes\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(countries.getAlpha2Codes());\n// { 'AF': 'AFG', 'AX': 'ALA', [...], 'ZM': 'ZMB', 'ZW': 'ZWE' }\n```\n\n### Get all Alpha-3 codes\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(countries.getAlpha3Codes());\n// { 'AFG': 'AF', 'ALA': 'AX', [...], 'ZMB': 'ZM', 'ZWE': 'ZW' }\n```\n\n### Get all Numeric codes\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(countries.getNumericCodes());\n// { '004': 'AF', '008': 'AL', [...], '887': 'YE', '894': 'ZM' }\n```\n\n### Validate country code\n\n```javascript\nvar countries = require(\"i18n-iso-countries\");\n// in a browser environment: countries.registerLocale(require(\"i18n-iso-countries/langs/en.json\"));\nconsole.log(\n  countries.isValid(\"US\"),\n  countries.isValid(\"USA\"),\n  countries.isValid(\"XX\")\n);\n// true, true, false\n```\n\n## Contribution\n\nTo add a language:\n\n- add a json file under [langs/](langs)\n- add the language to the list in supportedLocales.json at the top\n- add language to section **Supported languages** in [README.md](#supported-languages-iso-639-1)\n- add language to keywords in [package.json](package.json)\n- run `npm run lint` and `npm test`\n- open a PR on GitHub\n\nYou can check codes here: https://www.iso.org/obp/ui/#home\n\n[iso:639-1]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\n[iso:3166-1]: http://en.wikipedia.org/wiki/ISO_3166-1#Officially_assigned_code_elements\n","readmeFilename":"README.md"}