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

    country-code-emoji
    TypeScript icon, indicating that this package has built-in type declarations

    2.3.0 • Public • Published

    country-code-emoji

    convert country codes (ISO 3166-1 alpha-2) to corresponding emoji flags (unicode regional indicator symbols)

    about

    this is a completely dependency-free module to convert ascii letters to regional indicator symbols; for valid country codes, this results in that country's emoji flag. commonjs and es module builds are available via package.json's main and module. it relies on String.fromCodePoint internally, but does not provide any polyfills. if your environment does not support String.fromCodePoint, grab a polyfill like this one from mdn.

    install

    # npm
    npm install country-code-emoji
    
    # yarn
    yarn add country-code-emoji

    usage

    // commonjs module
    const { countryCodeEmoji, emojiCountryCode } = require('country-code-emoji');
    countryCodeEmoji('US'); // returns '🇺🇸'
    emojiCountryCode('🇺🇸'); // returns 'US'
    
    // es module
    import { countryCodeEmoji, emojiCountryCode } from 'country-code-emoji';
    ['AE', 'CN', 'GB'].map(countryCodeEmoji); // returns ['🇦🇪', '🇨🇳', '🇬🇧']
    ['🇦🇪', '🇨🇳', '🇬🇧'].map(emojiCountryCode); // returns ['AE', 'CN', 'GB']

    this module exports a pair of functions to convert country codes to/from flag emojis. the first is countryCodeEmoji(cc). it accepts a two-character (case-insensitive) country code and throws a TypeError if anything else is passed. more specifically, cc is expected to be a ISO 3166-1 alpha-2 country code. to keep things simple, if cc a two letter string, but not an actual ISO 3166-1 alpha-2 code, the regional indicator symbols corresponding to the letters in cc are returned. the second is emojiCountryCode(flag), which accepts a flag emoji and similarly throws a TypeError if anything else is passed.

    // default export is countryCodeEmoji
    import flag from 'country-code-emoji';
    
    flag(); // throws TypeError
    ['Us', 'uS', 'us'].every(e => flag(e) === flag('US')); // returns true
    flag('UK'); // returns '🇺🇰'

    Install

    npm i country-code-emoji

    DownloadsWeekly Downloads

    10,258

    Version

    2.3.0

    License

    MIT

    Unpacked Size

    11.3 kB

    Total Files

    9

    Last publish

    Collaborators

    • avatar