emoji-flags

return emoji flag symbol for country code

Install

1$ npm install --save emoji-flags

Usage

1var emojiFlags = require('emoji-flags');
2
3// single country lookup by code
4emojiFlags.countryCode('DK');
5// => { "code": "DK", "emoji": "🇩🇰", ... }
6
7// entire dataset
8emojiFlags.data;

CLI

1$ npm install --global emoji-flags

1$ emoji-flags --help
2
3  return emoji flag symbol for country code
4
5  Example
6    emoji-flags gb
7
8    emoji-flags dk --verbose
9
10    emoji-flags
11    => returns the entire dataset

API

countryCode

Option

Type: String
Default: undefined

Takes an ISO 3166-1 alpha-2 code, and returns country details:

1{
2    "code": "DK",
3    "emoji": "🇩🇰",
4    "unicode": "U+1F1E9 U+1F1F0",
5    "name": "Denmark",
6    "title": "flag for Denmark"
7}

Getters

The module exposes a bunch of simple getter methods:

• data - returns the entire dataset
• emojis - returns an array of all emojis
• codes - returns an array of all country codes
• names - returns an array of all country names
• unicodes - returns an array of all emojis reprensented as unicode

Getter methods for all country codes:

1emojiFlags.GB;
2// => {
3//      "code": "GB",
4//      "emoji": "🇬🇧",
5//      "unicode": "U+1F1EC U+1F1E7",
6//      "name": "United Kingdom",
7//      "title": "flag for United Kingdom"
8//    }

License

MIT © Matias Singers