# ekkis-country-list-js

> Country list with ISO2, ISO3 code, continent, capital, dialing code

Latest version **1.0.2** (published 2019-03-28) · 0 weekly downloads

## Install

```sh
npm install ekkis-country-list-js
pnpm add ekkis-country-list-js
yarn add ekkis-country-list-js
bun add ekkis-country-list-js
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-03-28 |
| First published | 2019-03-15 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 120.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 42 |
| Author | Rocky |
| Maintainers | ekkis |
| Keywords | country, country js, country list, country name, country code, country iso2, country iso3, country phone, country continent, country capital |

## Links

- npm: https://www.npmjs.com/package/ekkis-country-list-js
- Repository: https://github.com/i-rocky/country-list-js
- Homepage: https://github.com/i-rocky/country-list-js.git
- Issues: https://github.com/i-rocky/country-list-js/issues
- npm.io page: https://npm.io/package/ekkis-country-list-js

## Recent versions

- 1.0.2 (latest) — 2019-03-28
- 1.0.1 — 2019-03-15
- 1.0.0 — 2019-03-15

## README

# Country List JS

[![npm version](https://badge.fury.io/js/country-list-js.svg)](https://badge.fury.io/js/country-list-js)
[![Build Status](https://travis-ci.org/i-rocky/country-list-js.svg?branch=master)](https://travis-ci.org/i-rocky/country-list-js) [![Version](https://img.shields.io/npm/v/country-list-js.svg)](https://www.npmjs.com/package/country-list-js)
[![Total Downloads](https://img.shields.io/npm/dt/country-list-js.svg)](https://www.npmjs.com/package/country-list-js)
[![License](https://img.shields.io/github/license/i-rocky/country-list-js.svg)](https://github.com/i-rocky/country-list-js/blob/master/LICENSE)

This module contains country information including 2 and 3 character ISO codes, country and capital names,
currency information, telephone calling codes, and provinces (first-tier political subdivisions)

## Install
Add to your project from the NPM repository:
```
npm install --save country-list-js
```
And get an instance of the module:
```javascript
// using ES6 modules

import country from 'country-list-js';

// using CommonJS modules
var country = require('country-list-js'); 
```
In a web page, you can include the modulelike this:
```html
<script src="/path/to/country.min.js"></script>
```

## Basic Usage

The following methods are available:

### Searching
Searches can be conducted by any of the following methods:

```javascript
var found = country.findByIso2('BD');
var found = country.findByIso3('BGD');
var found = country.findByName('Bangladesh');
var found = country.findByCapital('Dakha');
var found = country.findByCurrency('BDT');
var found = country.findByPhoneNbr('+8804005050');
var found = country.findByProvince('Steiermark');
```

If the country cannot be found, the return value is  `undefined`.
If a single value is found, it is returned as an object similar to the
one shown below, and if multiple matches are made, an array of such
objects is returned

```javascript
{ 
    name: 'Denmark',
    continent: 'Europe',
    region: 'Scandinavia, Nordic Countries',
    capital: 'Copenhagen',
    currency: { code: 'DKK', symbol: 'Dkr', decimal: '2' },
    dialing_code: '45',
    provinces: [
        { name: 'Hovedstaden', alias: null },
        { name: 'Midtjylland', alias: null },
        { name: 'Nordjylland', alias: null },
        { name: 'Sjælland', alias: [ 'Zealand' ] },
        { name: 'Syddanmark', alias: null }
    ],
    code: { iso_alpha_2: 'DK', iso_alpha_3: 'DNK' } 
}
```

## Notes

* Queries are cached so only the first time a country is searched by requires traversal
of the internal structures and thus calls will resolve very quickly

* Search queries are case insensitive

* Province searches include aliases so you may search for either ***Sjælland*** or ***Zealand***

## NPM Commands

The built-in test suite may be run in the traditional way
```
npm run test
```

and to build the minified file for web run:
```
npm run build
```
and retrieve it from `dist/country.min.js`

---
_Source: https://npm.io/package/ekkis-country-list-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._