country-finder

1.0.8 • Public • Published

Country Finder

Get world countries. Minimal countries information finder

byCountryCode

find country by country code accepts both iso2 ( 2 letter) and iso3 ( 3 letter ) code

@param {String} code

const countryFinder = require("country-finder");
let result = countryFinder.byCountryCode("et");
/***
    {
        "id": 231,
        "name": "Ethiopia",
        "iso2": "ET",
        "iso3": "ETH",
        "continent": "Africa",
        "lat": "9.145",
        "long": "40.489673"
    }
*/

byId

find by using unique number of a country

@param {Integer} id

const countryFinder = require("country-finder");
let result = countryFinder.byId(344);
/***
    {
        "id": 344,
        "name": "Hong Kong",
        "iso2": "HK",
        "iso3": "HKG",
        "continent": "Asia",
        "lat": "22.396428",
        "long": "114.109497"
    }
*/

byName

Find by using country name

@param {String} name

const countryFinder = require("country-finder");
let result = countryFinder.byName("Ethiopia");
/***
    {
        "id": 231,
        "name": "Ethiopia",
        "iso2": "ET",
        "iso3": "ETH",
        "continent": "Africa",
        "lat": "9.145",
        "long": "40.489673"
    }
*/

byContinent

returns a list of countries that match a given continent

@param {String} continent

const countryFinder = require("country-finder");
let result = countryFinder.byContinent("Africa");
/***
[
  {
    id: 12,
    name: 'Algeria',
    iso2: 'DZ',
    iso3: 'DZA',
    continent: 'Africa',
    lat: '28.033886',
    long: '1.659626'
  },
  {
    id: 24,
    name: 'Angola',
    iso2: 'AO',
    iso3: 'AGO',
    continent: 'Africa',
    lat: '-11.202692',
    long: '17.873887'
  },
  .
  .
  .]
*/

all

a list of available countries with the following parameters

const countryFinder = require("country-finder");
let result = countryFinder.all();
/***
[
  {
    id: 12,
    name: 'Algeria',
    iso2: 'DZ',
    iso3: 'DZA',
    continent: 'Africa',
    lat: '28.033886',
    long: '1.659626'
  },
  {
    id: 24,
    name: 'Angola',
    iso2: 'AO',
    iso3: 'AGO',
    continent: 'Africa',
    lat: '-11.202692',
    long: '17.873887'
  },
  .
  .
  .]
*/
The following information is associated with each country
  • id
  • name
  • iso2
  • iso3
  • continent
  • lat
  • long

Package Sidebar

Install

npm i country-finder

Weekly Downloads

157

Version

1.0.8

License

ISC

Unpacked Size

53.3 kB

Total Files

5

Last publish

Collaborators

  • yonasg_