world-countries-capitals

world-countries-capitals

Want to contribute to open source? check issues here.

A simple NPM package to get capitals, currency, native language etc. of all the countries in the world

Getting started

Installation

This is a Node.js module available through the npm registry.

Before using, download and install Node.js.

Installation is done using the npm install command:

$ npm i world-countries-capitals --save

---

Importing

const wcc = require('world-countries-capitals');

---

Usage

• getAllCountryDetails() This method returns an array of objects of all countries, each containing country, capital, currency and native_language.

    [
        {
            "country": "Afghanistan",
            "capital": "Kabul",
            "currency": "Afghani",
            "native_language": "Dari Persian, Pashto"
        },
        {
            "country": "Albania",
            "capital": "Tirane",
            "currency": "Lek",
            "native_language": "Albanian"
        },

        ...
    ]

---

• getAllCountries() This method returns an array of names of all countries.

    [
        'Afghanistan',
        'Albania',
        'Algeria',
        'Andorra',
        'Angola',
        'Antigua & Barbuda',
        'Argentina',
        'Armenia',
        'Australia',
        'Austria',
        'Azerbaijan',
        ...
    ]

---

• getCountiesByLanguage(languageSpoken) This method returns an array of objects, each containing country, capital, currency and native_language sorted by the languageSpoken.

Response for languageSpoken = 'Hindi'

[
	{
		country: 'Fiji',
		capital: 'Suva',
		currency: 'Fijian Dollar',
		native_language: 'english, bau fijian, hindi',
	},
	{
		country: 'India',
		capital: 'New Delhi',
		currency: 'Indian Rupee',
		native_language: 'hindi, english',
	},
];

---

• getCountryDetailsByName(countryName) This method returns an array of objects, each containing country, capital, currency and native_language sorted by the name of the country .

Response for countryName = 'india'

[
	{
		country: 'india',
		capital: 'New Delhi',
		currency: 'Indian Rupee',
		native_language: 'Hindi, English',
	},
];

---

• getCountryDetailsByCapital(capital) This method returns an array of objects, each containing country, capital, currency and native_language sorted by the capital .

Response for capital = 'delhi'

[
	{
		country: 'India',
		capital: 'new delhi',
		currency: 'Indian Rupee',
		native_language: 'Hindi, English',
	},
];

---

• getRandomCountry() This method returns a random country everytime.

» node app.js
Tuvalu

» node app.js
Bhutan

» node app.js
Saudi Arabia

where app.js is the file containing the function call.

---

• getNRandomCountriesData(n) This method returns an array having n random country objects, each object containing country, capital, currency and native_language.

Response for n = 3

[
	{
		country: 'Burundi',
		capital: 'Bujumbura',
		currency: 'Burundi Franc',
		native_language: 'Kirundi, French',
	},
	{
		country: 'Palau',
		capital: 'Melekeok',
		currency: 'United States Dollar',
		native_language: 'English, Palauan',
	},
	{
		country: 'Dominican Republic',
		capital: 'Santo Domingo',
		currency: 'Dominican Peso',
		native_language: 'Spanish',
	},
];

---

Examples

#1

const wcc = require('world-countries-capitals');

console.log(wcc.getRandomCountry());

#2

const wcc = require('world-countries-capitals');

console.log(wcc.getNRandomCountriesData(3));

#3

	const wcc = require('world-countries-capitals');

	console.log(wcc.getCountryDetailsByCapital('delhi));

in this example the parameter (capital), which has to be a string can be a written in uppercase/lowercase etc. the response will be the same.

#4

	const wcc = require('world-countries-capitals');

	console.log(wcc.getCountryDetailsByName('India));

in this example the parameter (countryName), which has to be a string can be a written in uppercase/lowercase etc. the response will be the same.

#5

	const wcc = require('world-countries-capitals');

	console.log(wcc.getCountiesByLanguage('hindi));

in this example the parameter (languageSpoken), which has to be a string can be a written in uppercase/lowercase etc. the response will be the same.

#6

const wcc = require('world-countries-capitals');

console.log(wcc.getAllCountryDetails());

#7

const wcc = require('world-countries-capitals');

console.log(wcc.getAllCountries());

---

Want to contribute?

Please check issues here!

---

License

---

Let's get connected

---

Changelog

1.2.2 (February 08, 2020)

• README updated with invitation to contribute - #7 - @sudhanshu647