Git Product home page Git Product logo

country-emoji's Introduction

country-emoji

Build Status Codeship Status for meeDamian/country-emoji Coverage Status codecov.io npm version XO code style Dependency Status devDependency Status

Converts between country names, ISO 3166-1 codes and flag emojis. Has zero dependencies.

Install

$ npm install --save country-emoji

Usage

const {flag, code, name} = require('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'))))))
 // ~> ๐Ÿ‡ณ๐Ÿ‡ฟ

Bugs and feedback

If you discover a bug please report it here.

Mail me at [email protected], or on twitter @meeDamian.

codecov.io

License

MIT @ Damian Mee

country-emoji's People

Contributors

kylekellogg avatar meedamian avatar morajabi avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.