cf-emoji

Ultra-fast country code to flag emoji converter, with locale support. Up to 17x faster than alternatives.

Features

• 🚀 Ultra-fast performance (~17x faster than country-code-to-flag-emoji)
• 🌐 Supports both country codes (US) and locale codes (en-US)
• 💾 Smart caching for common country codes
• 🔄 Case-insensitive input handling
• 📦 Zero dependencies
• 🧪 100% test coverage
• 💻 Written in TypeScript
• 🛠️ Built with Bun

Installation

1# Using npm
2npm install cf-emoji
3
4# Using yarn
5yarn add cf-emoji
6
7# Using pnpm
8pnpm add cf-emoji
9
10# Using bun
11bun add cf-emoji

Usage

1import { toFlag } from 'cf-emoji';
2
3// Using country codes
4console.log(toFlag('US')); // 🇺🇸
5console.log(toFlag('GB')); // 🇬🇧
6console.log(toFlag('JP')); // 🇯🇵
7
8// Using locale codes
9console.log(toFlag('en-US')); // 🇺🇸
10console.log(toFlag('en-GB')); // 🇬🇧
11console.log(toFlag('ja-JP')); // 🇯🇵
12
13// Case-insensitive
14console.log(toFlag('us')); // 🇺🇸
15console.log(toFlag('en-gb')); // 🇬🇧

Performance

Benchmark results comparing cf-emoji with country-code-to-flag-emoji:

1Benchmark Results:
2==================================================
3Implementation       Total Time      Avg Time        Ratio
4--------------------------------------------------
5dalist               48.877ms        0.049µs         1.00x
6wojtech              826.424ms       0.826µs         16.91x

API

toFlag(code: string): string

Converts a country code or locale code to its corresponding flag emoji.

• code: A 2-letter country code (ISO 3166-1 alpha-2) or locale code
• Returns: Flag emoji string
• Throws: Error if the code is invalid

Development

1# Clone the repository
2git clone https://github.com/dalist1/cf-emoji.git
3
4# Install dependencies
5bun install
6
7# Run tests
8bun test
9
10# Run benchmark
11bun bench

License

MIT © Dalist