Want to contribute to open source? check issues here.

world-countries-capitals

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, native_language and famous for.

    [
        {
            "country": "afghanistan",
            "capital": "kabul",
            "currency": "afghani",
            "native_language": ["dari persian", "pashto"],
            "famous_for": "rugs, taliban"
        },
        {
            "country": "albania",
            "capital": "tirane",
            "currency": "lek",
            "native_language": ["albanian"],
            "famous_for" : "mother teresa"
        },

        ...
    ]

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, native_language and famous_for sorted by the languageSpoken.

Response for languageSpoken = 'Hindi'

[
	{
    {
        country: "fiji",
        capital: "suva",
        currency: "fijian dollar",
        native_language: ["english", "bau fijian", "hindi"],
        famous_for: "friendly people and heavenly tropical islands"
    },
    {
        country: "india",
        capital: "new delhi",
        currency: "indian rupee",
        native_language: ["hindi", "english"],
        famous_for: "bollywood, yoga, hinduism, food and diversity"
    }
];

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

Response for countryName = 'india'

[
    {
        country: "india",
        capital: "new delhi",
        currency: "indian rupee",
        native_language: ["hindi", "english"],
        famous_for: "bollywood, yoga, hinduism, food and diversity"
    }
];

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"],
        famous_for: "bollywood, yoga, hinduism, food and diversity"
    }
];

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"],
        famous_for: "wildlife and greenery"
    },
    {
        country: "palau",
        capital: "melekeok",
        currency: "united states dollar",
        native_language: ["english", "palauan"],
        famous_for: "jellyfish lake",
    },
    {
        country: "dominican republic",
        capital: "santo domingo",
        currency: "dominican peso",
        native_language: ["spanish"],
        famous_for: "blue ocean water, white-sand beaches and beautiful resorts"
    }
];

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!

sushant2 / world-countries-capitals Goto Github PK

world-countries-capitals's Introduction

Want to contribute to open source? check issues here.

world-countries-capitals

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

Getting started

Installation

Importing

Usage

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

Examples

#1

#2

#3

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

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

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

#7

Want to contribute?

License

Let's get connected

world-countries-capitals's People

Contributors

Watchers

Recommend Projects

Recommend Topics

Recommend Org