Giter Club home page Giter Club logo

african-countries's Introduction

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.

african-countries's People

Contributors

dependabot[bot] avatar odusanya avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.