Mobitel Ltd. ISO-3166 Countries
NodeJs module based on ISO-3166 for validate and get basic info by country
Attention
This module writing and testing on NodeJs v.8+ and NPM v.5+. Using the module in previous versions of NodeJs does not guarantee correct works.
Navigation
Installation
npm i --save mobitel-iso-3166-countries
Example
Now for each country exist:
- country - Country name
- alpha2- Alphabetic code of country (2 symbols)
- alpha3 - Alphabetic code of country (3 symbols)
- numeric - Numeric code of country
const isoCountries = ; // validateconst valid2 = isoCountries; //=> trueconst valid3 = isoCountries; //=> trueconst validNum = isoCountries; //=> trueconst invalid2 = isoCountries; //=> falseconst invalid3 = isoCountries; //=> falseconst invalidNum = isoCountries; //=> false // get dataconst data2 = isoCountries; //=> {country: 'Afghanistan', alpha2: 'AF', alpha3: 'AFG', numeric: '004'}const data3 = isoCountries; //=> {country: 'Afghanistan', alpha2: 'AF', alpha3: 'AFG', numeric: '004'}const dataNum = isoCountries; //=> {country: 'Afghanistan', alpha2: 'AF', alpha3: 'AFG', numeric: '004'}const noData2 = isoCountries; //=> nullconst noData3 = isoCountries; //=> nullconst noDataNum = isoCountries; //=> null // get list of codesconst listOfCodes1 = isoCountries; //=> ['AFG', ...]const listOfCodes2 = isoCountries; //=> ['AFG', ..., '004', ...]const listOfCodes3 = isoCountries; //=> ['AFG', ...]const listOfCodes4 = isoCountries; //=> ['AFG', ..., '004', ...] const listOfCodes5 = isoCountries; //=> nullconst listOfCodes7 = isoCountries; //=> nullconst listOfCodes6 = isoCountries; //=> nullconst listOfCodes8 = isoCountries; //=> null
API
.list
Property - {country: String, alpha2: String, alpha3: String, numeric: String}[]
- contains full countries list.
Example
const list = isoCountrieslist; //=> objects list
.validate(code)
Argument - String
- country code like 'AF'
(alpha2), 'AFG'
(alpha3) or '004'
(numeric).
If code exist return true
, otherwise false
.
Example
const valid2 = isoCountries; //=> trueconst valid3 = isoCountries; //=> trueconst validNum = isoCountries; //=> trueconst invalid2 = isoCountries; //=> falseconst invalid3 = isoCountries; //=> falseconst invalidNum = isoCountries; //=> false
.get(code)
Argument - String
- country code like 'AF'
(alpha2), 'AFG'
(alpha3) or '004'
(numeric).
If code exist return object with simple country data like
{country: 'Afghanistan', alpha2: 'AF', alpha3: 'AFG', numeric: '004'}
, otherwise null
.
Example
const data2 = isoCountries; //=> {country: 'Afghanistan', alpha2: 'AF', alpha3: 'AFG', numeric: '004'}const data3 = isoCountries; //=> {country: 'Afghanistan', alpha2: 'AF', alpha3: 'AFG', numeric: '004'}const dataNum = isoCountries; //=> {country: 'Afghanistan', alpha2: 'AF', alpha3: 'AFG', numeric: '004'}const noData2 = isoCountries; //=> nullconst noData3 = isoCountries; //=> nullconst noDataNum = isoCountries; //=> null
.getCodeList(codeName[, codeName]|[codeName[, codeName]])
Arguments - String|String[]
- country code name. Can accept variants:
codeName1
codeName1, codeName2
[codeName1]
[codeName1, codeName2]
Return array of all exist codes from arguments or null
.
Example
const listOfCodes1 = isoCountries; //=> ['AFG', ...]const listOfCodes2 = isoCountries; //=> ['AFG', ..., '004', ...]const listOfCodes3 = isoCountries; //=> ['AFG', ...]const listOfCodes4 = isoCountries; //=> ['AFG', ..., '004', ...] const listOfCodes5 = isoCountries; //=> nullconst listOfCodes7 = isoCountries; //=> nullconst listOfCodes6 = isoCountries; //=> nullconst listOfCodes8 = isoCountries; //=> null
Test
npm run test
License
MIT License.
Copyright (c) 2017 Mobitel Ltd
up to navigation