Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meedamian/country-emoji
Converts between country names, ISO 3166-1 codes and flag emojis.
https://github.com/meedamian/country-emoji
country-emoji country-names emoji flag iso3166-1 nodejs
Last synced: 2 days ago
JSON representation
Converts between country names, ISO 3166-1 codes and flag emojis.
- Host: GitHub
- URL: https://github.com/meedamian/country-emoji
- Owner: meeDamian
- License: mit
- Created: 2016-10-07T18:21:22.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-14T23:52:10.000Z (4 months ago)
- Last Synced: 2025-01-12T19:05:00.415Z (9 days ago)
- Topics: country-emoji, country-names, emoji, flag, iso3166-1, nodejs
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/country-emoji
- Size: 963 KB
- Stars: 85
- Watchers: 4
- Forks: 25
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# country-emoji
[![npm_svg]][npm_url]
[![npm_beta_svg]][npm_url]
[![dl_url]][npm_url]
[![coveralls_svg]][coveralls_url]
[![codecov_svg]][codecov_url]
[![xo_svg]][xo_url]
[![license_svg]][license_url]
[npm_svg]: https://img.shields.io/npm/v/country-emoji
[npm_beta_svg]: https://img.shields.io/npm/v/country-emoji/beta
[npm_url]: https://www.npmjs.com/package/country-emoji
[dl_url]: https://img.shields.io/npm/dw/country-emoji
[coveralls_svg]: https://coveralls.io/repos/github/meeDamian/country-emoji/badge.svg?branch=master
[coveralls_url]: https://coveralls.io/github/meeDamian/country-emoji?branch=master
[codecov_svg]: https://codecov.io/github/meeDamian/country-emoji/coverage.svg?branch=master
[codecov_url]: https://codecov.io/github/meeDamian/country-emoji?branch=master
[xo_svg]: https://img.shields.io/badge/code_style-XO-5ed9c7.svg
[xo_url]: https://github.com/sindresorhus/xo
[license_svg]: https://img.shields.io/npm/l/country-emoji
[license_url]: https://github.com/meeDamian/country-emoji/blob/master/LICENSE
Converts between country names, ISO 3166-1 codes and flag emojis. **Has zero dependencies.**
## Installation
Install the package via npm:
```bash
# Stable version
npm install country-emoji
# Or the beta version
npm install country-emoji@beta
```
## Usage
```js
// CommonJS
const { flag, code, name, countries } = require('country-emoji');
// ES Modules (if using v2+ version)
import { flag, code, name, countries } from 'country-emoji';
flag('CL')
// ~> π¨π±
code('π¨π¦')
// ~> CA
name('πΆπ¦')
// ~> Qatar
// can extract name from stringβ¦
flag('Taiwan number one!')
// ~> πΉπΌ
// β¦but only if there's no ambiguity
flag('Congo and Burma')
// ~> undefined
flag('Republic of Tanzania')
// ~> πΉπΏ
flag('Tanzania, United Republic of')
// ~> πΉπΏ
code('Australia')
// ~> AU
code('UAE')
// ~> AE
name('AE')
// ~> United Arab Emirates
code('UK')
// ~> GB
// all values can be converted back and forth indefinitely
flag(name(flag(code(flag(name('NZ'))))))
// ~> π³πΏ
// a dictionary (of country code to country name) of all countries
Object.keys(countries).join(", ")
// ~> AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BM, BN, BO, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, EU, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW
```
### Don't want JS?
Check out the following:
language | repo | package manager | issue
-:|-|:-:|:-:
**Swift** | [SwiftFlags][swift] | | [#16]
**Rust** | [country-emoji][rust] | [crates.io] | [#20]
**Python** | [country-emoji][python] | [PyPI] | [#40]
[swift]: https://github.com/BubiDevs/SwiftFlags
[#16]: https://github.com/meeDamian/country-emoji/issues/16
[rust]: https://github.com/leodutra/country-emoji
[crates.io]: https://crates.io/crates/country-emoji
[#20]: https://github.com/meeDamian/country-emoji/issues/20
[python]: https://github.com/Nnonexistent/country-emoji
[PyPI]: https://pypi.org/project/country-emoji/
[#40]: https://github.com/meeDamian/country-emoji/issues/40
PS. Happy to add more here :).
### Want just data?
Check out [REST Countries](https://restcountries.com/) project (with complete JSON [here](https://restcountries.com/v3.1/all)).
## Bugs and feedback
If you discover a bug please report it [here](https://github.com/meeDamian/country-emoji/issues/new).
Mail me at [email protected], or on π [@meeDamian](http://x.com/meedamian).
## License
MIT @ [Damian Mee](https://meedamian.com)