npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

country-codes-and-flags

v1.0.3

Published

A TypeScript library mapping country names and ISO codes to their corresponding flag emoji

Downloads

172

Readme

Country Codes and Flags ⛳️

Features

This package provides utilities for

  • retrieving a country's flag emoji, ISO alpha2, and ISO alpha3 codes given the country's name
  • reverse lookups to go from ISO codes or a flag emoji back to a country's name
  • retrieving a full dataset object that maps country names to their flags and iso codes

You can also find the full set of country data here

Installation

npm install country-codes-and-flags

Usage

Available Methods

| Function | Input Type | Input | Output | |----------------------|------------|---------------------------|------------------------------------------------------------------------------------------------| | getFlagByCountry | string | Country name | Flag emoji string or null | | getFlagByAlpha2 | string | Two-letter country code | Flag emoji string or null | | getFlagByAlpha3 | string | Three-letter country code | Flag emoji string or null | | getAlpha2ByCountry | string | Country name | Two-letter country code string or null | | getAlpha3ByCountry | string | Country name | Three-letter country code string or null | | getCountryFromFlag | string | Flag emoji | Country name string or null | | getCountryByAlpha2 | string | Two-letter country code | Country name string or null | | getCountryByAlpha3 | string | Three-letter country code | Country name string or null | | getAllByCountry | string | Country name | CountryMetadata object or null | | getAll | N/A | none | Returns the full dataset ({ [COUNTRY_NAME: { flag: string; alpha2: string; alpha3: string}}) |

Examples

import {getAllByCountry, getFlagByCountry, getCountryFromFlag} from "country-codes-and-flags";

// Get All Metadata
const greeceData = getAllByCountry("Greece");
console.log(greeceData)
// Output:
// {
//   'flag': '🇬🇷',
//   'alpha2': 'GR',
//   'alpha3: 'GRC',
// }

// Get Flag
const greeceFlag = getFlagByCountry("Greece");
console.log(greeceFlag)
// Output:
// '🇬🇷'

// Get Country
const greeceName = getCountryFromFlag("🇬🇷");
console.log(greeceName)
// Output:
// 'Greece'

Handling Invalid Inputs

Invalid inputs or non-matching country names will result in null being returned. Planning to implement more descriptive error handling in future versions

Building the Library

You can clone this repo and build it locally with the following command:

npm run build

This will generate builds in the dist directory.

Contributing

Any contributions or suggestions for improvements are welcome! Please open an issue or submit a pull request.

Contact

For comments or questions email [email protected]

License

MIT