@apolitical/geography

Geographical definitions used by Apolitical services

Stats

StarsIssuesVersionUpdatedCreatedSize
@apolitical/geography
031.1.03 years ago3 years agoMinified + gzip package size for @apolitical/geography in KB

Readme

geography

Geographical definitions used by Apolitical services. Currently provides lookup functions from regions to a list of countries in that region.

Usage

const {
  regions,
  countriesInRegion,
  countryCodesInRegion,
  countryNamesInRegion,
} = require('@apolitical/geography');

OR

import {
  regions,
  countriesInRegion,
  countryCodesInRegion,
  countryNamesInRegion,
} from '@apolitical/geography';


regions() // Get a list of region codes

regionName('afr', 'en-GB') // The name of the afr region in UK English (i.e. Africa)

countryNamesInRegion('afr') // Country names in Africa
countryCodesInRegion('eur') // Country code in Europe
countriesInRegion('na') // Code->name map for North America

For full browser support (including IE 10 & 11), you will need to use babel-polyfill in your application.

Regions

The region codes correspond to:

code name
afr Africa
cas Central Asia
eap East Asia & Pacific
eur Europe
lac Latin America & Caribbean
mena Middle East & North Africa
na North America
oc Oceania
sar South Asia

These are based on regions defined by the World Bank, except that we include Oceania, North America, and split out Europe and Central Asia.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.