@odusanya/african-countries
TypeScript icon, indicating that this package has built-in type declarations

3.0.0-rc.6 • Public • Published

African Countries Data NPM GitHub package.json version

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

JavaScript Style Guide

Installation

You can install this package via npm or yarn:

  1. Via npm:
npm install @odusanya/african-countries
  1. 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:

  1. Get all countries:
const allCountries = countries.getAllCountries();
console.log(allCountries.length); // 54 
console.log(allCountries); 
  1. Get country by code:
const country = countries.getCountryByCode('ml');
console.log(country);
  1. 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.

Package Sidebar

Install

npm i @odusanya/african-countries

Weekly Downloads

1,079

Version

3.0.0-rc.6

License

MIT

Unpacked Size

44.7 kB

Total Files

15

Last publish

Collaborators

  • odusanya