Nullifying Precipitation Machine

npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

country-code-emoji

1.0.0 • Public • Published

country-code-emoji

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

Build Status

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, es module, and umd (transpiled to es5) builds are available via package.json's main, module, and browser properties, respectively. 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 flag = require('country-code-emoji');
flag('US'); // returns '🇺🇸'
 
// es module
import flag from 'country-code-emoji';
['AE', 'CN', 'GB'].map(flag); // returns [ '🇦🇪', '🇨🇳', '🇬🇧' ]

this module exports a single function with the signature flag(cc). cc should be atwo-character (case-insensitive) country code, and a TypeError will be thrown if it isn't. 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.

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

969

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability