country-info-package

country-info-package is an npm package designed to provide detailed information about countries. It includes data such as country codes, names, flags, languages, and more, simplifying the process of accessing country-related information for developers.

Installation

To install the country-info-package npm package, use the following command:

1npm install country-info-package

How To Use

1import { getCountryInfo } from "country-info-package";
2
3// Example usage
4
5// By country code
6const countryByCode = getCountryInfo("ZW");
7console.log(countryByCode);
8
9// By country title
10const countryByTitle = getCountryInfo("Zimbabwe");
11console.log(countryByTitle);
12
13// By phone code
14const countryByPhoneCode = getCountryInfo("+263");
15console.log(countryByPhoneCode);

Example Output

The getCountryInfo function returns an object with detailed country information:

1{
2  "title": "Zimbabwe",
3  "code": "ZW",
4  "time_zone": "UTC+2",
5  "currency": {
6    "name": "Zimbabwean Dollar",
7    "symbol": "$"
8  },
9  "languages": ["English", "Shona", "Sindebele"],
10  "ISO_codes": {
11    "numeric": "716",
12    "alpha3": "ZWE"
13  },
14  "phone_code": "+263",
15  "area_km2": 390757,
16  "flag": "🇿🇲"
17}
18

API

getCountryInfo(value)

Parameters:

value (string): The country code (e.g., 'ZW'),

country title (e.g., 'Zimbabwe'), or

phone code (e.g., '+263').

Returns:

An object with country information, including the flag, or an object with a message if the country is not found.

Dependencies:

country-flag-icons: Provides country flag icons.

License

This package is licensed under the ISC License.

Author

Rizwan Khan (Captain)