# bc-countries

> A convenient Javascript countries utilities (e.g: dial codes, country codes, names)

Latest version **2.0.0** (published 2015-10-11) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install bc-countries
pnpm add bc-countries
yarn add bc-countries
bun add bc-countries
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2015-10-11 |
| First published | 2015-10-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 18 |
| Author | Abdullah Alansari |
| Maintainers | ahimta |
| Keywords | country, phone |

## Links

- npm: https://www.npmjs.com/package/bc-countries
- Repository: https://github.com/Ahimta/bc-countries
- Issues: https://github.com/Ahimta/bc-countries/issues
- npm.io page: https://npm.io/package/bc-countries

## Dependencies (2)

- [digits-trie](https://npm.io/package/digits-trie.md) ^1.0.0
- [google-libphonenumber](https://npm.io/package/google-libphonenumber.md) ^1.0.7

## Recent versions

- 2.0.0 (latest) — 2015-10-11
- 1.0.0 — 2015-10-10

## README

# bc-countries [![Build Status](https://travis-ci.org/blockchain/bc-countries.svg?branch=master)](https://travis-ci.org/blockchain/bc-countries)
A convenient Javascript countries utilities (e.g: dial codes, country codes, names)

## Installation

### Bower
```bash
bower install --save bc-countries
```

```js
var bcCountries = window.bcCountries;
```

### NPM
```bash
npm install --save bc-countries
```

```js
var bcCountries = require('bc-countries');
```

### Other (not recommended)
Just copy the [dist](https://github.com/Ahimta/bc-countries/tree/master/dist)

## Usage

### Main functions
A country is an object with keys (dialCode, iso2Code, name).
Functions that take `digits`, throw unless `digits` is a string of digits.

1. `getCountryByIso2Code(iso2Code)`: returns the country with iso2 code `code` if exists, `null` otherwise.
2. `getIso2CodeByDigits(digits)`: returns the iso2 code, given that `digits` starts with that country dial code, an empty string otherwise.
3. `getDialCodeByDigits(digits)`: returns the dial code, given that `digits` starts with that country dial code, an empty string otherwise.
4. `getAllCountries()`: returns all countries.

You can find the full documentation [here](https://github.com/Ahimta/bc-countries/tree/master/test.js).

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