Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yusufshakeel/dycountryjs
Dictionary to get country info.
https://github.com/yusufshakeel/dycountryjs
country javascript json
Last synced: 4 days ago
JSON representation
Dictionary to get country info.
- Host: GitHub
- URL: https://github.com/yusufshakeel/dycountryjs
- Owner: yusufshakeel
- License: mit
- Created: 2018-07-19T06:14:12.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-07-31T10:39:45.000Z (over 6 years ago)
- Last Synced: 2024-11-09T20:44:38.702Z (2 months ago)
- Topics: country, javascript, json
- Language: JavaScript
- Homepage:
- Size: 325 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# dyCountryJS
Dictionary to get country info.
## Status
[](https://github.com/yusufshakeel/dyCountryJS)
[](https://www.npmjs.com/package/dycountryjs)
[](https://travis-ci.org/yusufshakeel/dyCountryJS)
[](https://www.jsdelivr.com/package/npm/dycountryjs)
## Getting Started
* Download the [latest release](https://github.com/yusufshakeel/dyCountryJS/releases) of the project.
* Clone the repo: `git clone https://github.com/yusufshakeel/dyCountryJS.git`
* Install via npm: `npm install --save dycountryjs`
* Use from jsDelivr CDN: `https://www.jsdelivr.com/package/npm/dycountryjs`
## Documentation
Check the `index.html` file of this project.
## How to setup?
Run `npm install` to install all the packages.
Then run `npm run all` to build and run the tests.
You will get the minified file inside `dist/js` directory.
## How to use?
Step 1: Include dyCountry.min.js file.
```HTML
dyCountryJS Demo
```
Step 2: Create an instance of dyCountry class and pass an optional config.
```JavaScript
var config = {
flagDir: 'path/to/dist/flags'
};
var obj = new dyCountry(config);
```
Step 3: Call methods like ```get``` to fetch data of a country based on ISO-Alpha-2 or ISO-Alpha-3 code.
```
var data = obj.get('IN');
```
# Methods
## ```get()``` returns the country detail
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country information.
```JavaScript
obj.get('IN');
```
```JavaScript
obj.get('IND');
```
### Result
```
{
"name": "India",
"capital": "New Delhi",
"continent": {
"code": "AS",
"name": "Asia"
},
"iso": {
"alpha2": "IN",
"alpha3": "IND",
"numeric": "356"
},
"timezone": {
"capital": "Asia/Kolkata"
},
"latlong": {
"lat": 20.593684,
"long": 78.96288
},
"topLevelDomain": "in",
"fipsCode": "IN",
"phoneCode": [
"91"
],
"currencies": [
"INR"
],
"languages": [
"en-IN"
],
"flag": "dist/flags/in.png"
}
```
## ```name()``` returns the country name
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country name.
```JavaScript
obj.name('IN');
```
```JavaScript
obj.name('IND');
```
### Result
```
"India"
```
## ```capital()``` returns the country capital
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country capital.
```JavaScript
obj.capital('IN');
```
```JavaScript
obj.capital('IND');
```
### Result
```
"New Delhi"
```
## ```flag()``` returns the country flag image path
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country flag image path.
```JavaScript
obj.flag('IN');
```
```JavaScript
obj.flag('IND');
```
### Result
```
"dist/flags/in.png"
```
Using the flag path in ```img``` HTML element:
## ```latlong()``` returns the country lat-long data
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country lat-long data.
```JavaScript
obj.latlong('IN');
```
```JavaScript
obj.latlong('IND');
```
### Result
```
{
"lat": 20.593684,
"long": 78.96288
}
```
Pass ISO-Alpha-2 or ISO-Alpha-3 country code and key to the method and it will return either country lat/long country data.
```JavaScript
obj.latlong('IN', 'lat');
```
```JavaScript
obj.latlong('IND', 'lat');
```
### Result
```
20.593684
```
## ```iso()``` returns the country iso data
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country iso data.
```JavaScript
obj.iso('IN');
```
```JavaScript
obj.iso('IND');
```
### Result
```
{
"alpha2": "IN",
"alpha3": "IND",
"numeric": "356"
}
```
Pass ISO-Alpha-2 or ISO-Alpha-3 country code and key to the method and it will return specify country iso data.
```JavaScript
obj.iso('IN', 'alpha3');
```
```JavaScript
obj.iso('IND', 'alpha3');
```
### Result
```
"IND"
```
## ```continent()``` returns the country continent data
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country continent data.
```JavaScript
obj.continent('IN');
```
```JavaScript
obj.continent('IND');
```
### Result
```
{
"code": "AS",
"name": "Asia"
}
```
Pass ISO-Alpha-2 or ISO-Alpha-3 country code and key to the method and it will return specify country continent data.
```JavaScript
obj.continent('IN', 'name');
```
```JavaScript
obj.continent('IND', 'name');
```
### Result
```
"Asia"
```
## ```tld()``` returns the country top level domain
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country tld.
```JavaScript
obj.tld('IN');
```
```JavaScript
obj.tld('IND');
```
### Result
```
"in"
```
## ```timezone()``` returns the country timezone for capital
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country timezone.
```JavaScript
obj.timezone('IN');
```
```JavaScript
obj.timezone('IND');
```
### Result
```
"Asia/Kolkata"
```
## ```fipsCode()``` returns the country fips code
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country fips code.
```JavaScript
obj.fipsCode('IN');
```
```JavaScript
obj.fipsCode('IND');
```
### Result
```
"IN"
```
## ```phoneCode()``` returns the country phone code
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country phone code.
```JavaScript
obj.phoneCode('IN');
```
```JavaScript
obj.phoneCode('IND');
```
### Result
```
[
"91"
]
```
## ```currencies()``` returns the country currencies
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country currencies.
```JavaScript
obj.currencies('IN');
```
```JavaScript
obj.currencies('IND');
```
### Result
```
[
"INR"
]
```
## ```languages()``` returns the country languages
Pass ISO-Alpha-2 or ISO-Alpha-3 country code to the method and it will return the country languages.
```JavaScript
obj.languages('IN');
```
```JavaScript
obj.languages('IND');
```
### Result
```
[
"en-IN"
]
```
## ```all()``` returns all the countries detail
It will return all the countries detail.
```JavaScript
obj.all();
```
### Result
```
[
{ countryData },
{ countryData },
...
...
]
```
## ```search()``` returns all the countries matching the search query
Pass string query to the method and it will return all the countries matching the country name.
```JavaScript
obj.search('India');
```
### Result
```JavaScript
{
"match": N,
"result": [
{ countryData },
{ countryData }
...
...
]
}
```
Where, `match` is the total number of matching result. If no match is found then `N` will be 0 and `result` will be an empty array [].
### Search by name
Pass object with `name` parameter query to the method and it will return all the countries matching country name.
```JavaScript
obj.search({ name: 'India' });
```
Pass array of names and it will return all the matching countries.
```JavaScript
obj.search({ name: ['ind', 'aus'] });
```
### Search by capital
Pass object with `capital` parameter query to the method and it will return all the countries matching country capital.
```JavaScript
obj.search({ capital: 'Delhi' });
```
Pass array of capitals and it will return all the matching countries.
```JavaScript
obj.search({ capital: ['delhi', 'tokyo'] });
```
### Search by topLevelDomain
Pass object with `topLevelDomain` parameter query to the method and it will return all the countries matching Top Level Domain.
```JavaScript
obj.search({ topLevelDomain: 'in' });
```
Pass array of topLevelDomain and it will return all the matching countries.
```JavaScript
obj.search({ topLevelDomain: ['in', 'au'] });
```
### Search by fipsCode
Pass object with `fipsCode` parameter query to the method and it will return all the countries matching FIPS code.
```JavaScript
obj.search({ fipsCode: 'in' });
```
Pass array of fipsCode and it will return all the matching countries.
```JavaScript
obj.search({ fipsCode: ['in', 'us'] });
```
### Search by phoneCode
Pass object with `phoneCode` parameter query to the method and it will return all the countries matching phone code.
```JavaScript
obj.search({ phoneCode: '91' });
```
Pass an array of phone code and it will return all the matching countries.
```JavaScript
obj.search({ phoneCode: ['90', '91'] });
```
### Search by currencies
Pass object with `currencies` parameter query to the method and it will return all the countries matching currencies.
```JavaScript
obj.search({ currencies: 'INR' });
```
Pass array of currencies and it will return all the matching countries.
```JavaScript
obj.search({ currencies: ['INR', 'USD'] });
```
### Search by languages
Pass object with `languages` parameter query to the method and it will return all the countries matching languages.
```JavaScript
obj.search({ languages: 'hi' });
```
Pass array of languages and it will return all the matching countries.
```JavaScript
obj.search({ languages: ['hi', 'la'] });
```
### Search by continentCode
Pass object with `continentCode` parameter query to the method and it will return all the countries having that continent code.
```JavaScript
obj.search({ continentCode: 'AS' });
```
Pass array of continent code and it will return all the matching countries.
```JavaScript
obj.search({ continentCode: ['AS', 'AN'] });
```
### Search by continentName
Pass object with `continentName` parameter query to the method and it will return all the countries having that continent name.
```JavaScript
obj.search({ continentName: 'Asia' });
```
Pass array of continent names and it will return all the matching countries.
```JavaScript
obj.search({ continentName: ['Asia', 'Antarctica'] });
```
### Search by multi parameters
Pass object with multiple query parameters to the method and it will return all the matching countries.
Following example will fetch all contries having string `in` in its `name` AND string `del` in its `capital`.
```JavaScript
obj.search({ name: 'in', capital: 'del' });
```
## More methods...
* ```getSelectHTML()``` returns HTML select element of countries
Check the `index.html` file of this project.
# License
It's free and released under [MIT License](https://github.com/yusufshakeel/dyCountryJS/blob/master/LICENSE) Copyright (c) 2018 Yusuf Shakeel
Do whatever you want with this :-)
# Donate
Feeling generous :-) Buy me a cup of tea.
[Donate via PayPal](https://www.paypal.me/yusufshakeel)