@odusanya/african-countries
v3.0.0-rc.6
Published
JSON Library of countries in Africa and their country codes(ISO Alpha-2 and Alpha-3)
Downloads
1,901
Maintainers
Readme
African Countries Data
This is a lightweight JSON repository of all the 54 WHO recognised countries in Africa.
Each country object contains the following details:
- Country Code
- Country Name
- Calling Code
- Official Language
- Capital
- Currency
- Country Flag
- Internet users
- Population
Installation
You can install this package via npm or yarn:
- Via npm:
npm install @odusanya/african-countries
- Via yarn:
yarn add @odusanya/african-countries
Usage
You can import the package in your JavaScript file like this:
// ES6
import countries from '@odusanya/african-countries';
// ES5
var countries = require('@odusanya/african-countries');
The package provides the following functions:
- getAllCountries(): Returns an array of all the countries in Africa.
- getCountryByCode(code): Returns the country object for the given country code.
- searchCountryByName(name): Returns an array of countries that match the given name.
A sample country object looks like this
Examples
Here are some examples of how you can use these functions:
- Get all countries:
const allCountries = countries.getAllCountries();
console.log(allCountries.length); // 54
console.log(allCountries);
- Get country by code:
const country = countries.getCountryByCode('ml');
console.log(country);
- Search country by name:
const countries = countries.searchCountryByName('Gambia');
console.log(countries);
License
This package is licensed under the MIT license. Source
The country data is sourced from the ISO (International Organization for Standardization).
Contribution
Contributions are welcome! Feel free to send a PR to fix, update or add new entry anytime.
Roadmap
Future updates may include visa requirements for each country and automatic project documentation.