Wondering what’s next for npm?Check out our public roadmap! »

    emoji-flags
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/emoji-flags package

    1.3.0 • Public • Published

    emoji-flags Build Status Dependency Status

    return emoji flag symbol for country code

    Install

    $ npm install --save emoji-flags

    Usage

    var emojiFlags = require('emoji-flags');
     
    // single country lookup by code
    emojiFlags.countryCode('DK');
    // => { "code": "DK", "emoji": "🇩🇰", ... }
     
    // entire dataset
    emojiFlags.data;

    CLI

    $ npm install --global emoji-flags
    $ emoji-flags --help
     
      return emoji flag symbol for country code
     
      Example
        emoji-flags gb
     
        emoji-flags dk --verbose
     
        emoji-flags
        => returns the entire dataset

    API

    countryCode

    Option

    Type: String
    Default: undefined

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

    {
        "code": "DK",
        "emoji": "🇩🇰",
        "unicode": "U+1F1E9 U+1F1F0",
        "name": "Denmark",
        "title": "flag for Denmark"
    }

    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:

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

    License

    MIT © Matias Singers

    Install

    npm i emoji-flags

    DownloadsWeekly Downloads

    13,235

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    55.3 kB

    Total Files

    6

    Last publish

    Collaborators

    • avatar