country-to-currency
TypeScript icon, indicating that this package has built-in type declarations

1.1.5 • Public • Published

npm (tag) License npm

country-to-currency

Maps country codes (ISO 3166-1 alpha-2) to their default currency codes (ISO 4217).

⚡ Just 2.3 KB (uncompressed), no external dependencies.

🎯 Work with browsers, NodeJS, and DenoJS. JavaScript and TypeScript.

Install

npm i country-to-currency

Usage

This library exports a default object that maps country codes to currency codes.

Available formats include UMD (therefore AMD and CommonJS) and ESM.

TypeScript

From version 1.1.0 on, there are two union types available (TypeScript 3.4+ only):

  • Currencies, that contains all the currencies;
  • Countries, that contains all the countries.

Example (TypeScript on NodeJS):

  import countryToCurrency, { Currencies, Countries } from "country-to-currency";

Browser - without installing anything

Global:

<script crossorigin src="https://unpkg.com/country-to-currency" ></script>
<script>
  console.log( countryToCurrency ); // {AF: "AFN", AX: "EUR", ... }
  console.log( countryToCurrency[ 'US' ] ); // USD
  console.log( countryToCurrency[ 'DE' ] ); // EUR
  console.log( countryToCurrency[ 'BR' ] ); // BRL
</script>

ESM:

<script type="module" >
  import countryToCurrency from "https://unpkg.com/country-to-currency/index.esm.js";
  console.log( countryToCurrency[ 'US' ] ); // USD
</script>

NodeJS

const countryToCurrency = require( 'country-to-currency' );
console.log( countryToCurrency[ 'US' ] ); // USD

DenoJS

import countryToCurrency from "https://unpkg.com/country-to-currency/index.esm.js";
console.log( countryToCurrency[ 'US' ] ); // USD

Notes

  • Countries included: 250.
  • For Antarctica (AQ), the currency USD is being assumed.
  • For Chile (CLF), the currency CLP is being assumed.
  • For Croatia (HR), the currency EUR is being assumed since January 1st, 2023.
  • For Cuba (CU), the currency CUP is being assumed since 2021.
  • For Dominican Republic (DM), the currency XCD is being assumed.
  • For El Salvador (SV), the currency USD is being assumed.
  • For Hungary (HU), the currency HUF is being assumed.
  • For Niger (NE), the currency XOF is being assumed.
  • For Palestine (PS), the currency ILS is being assumed.
  • For Republic of the Congo (CG), the currency XAF is being assumed.
  • For Samoa (WS), the currency WST is being assumed.
  • For Sierra Leone (SL), the currency SLE is being assumed since since January 1st, 2024.
  • For South Georgia and the South Sandwich Islands (GS), the currency FKP is being assumed.
  • For South Korea (KR), the currency KRW is being assumed.
  • For Switzerland (CH), the currency CHF is being assumed.
  • For Uruguay (UY), the currency UYU is being assumed.

Suggestions? Please open an Issue. Pull Requests? Make sure to edit generate.js instead of index.ts.

License

This library is inspired by Michael Rhodes' currency-code-map. The current project adds new currencies, offers support to browsers and DenoJS, updates dependencies, and provides new internal scripts.

MIT © Thiago Delgado Pinto

Package Sidebar

Install

npm i country-to-currency

Weekly Downloads

21,137

Version

1.1.5

License

MIT

Unpacked Size

30.5 kB

Total Files

9

Last publish

Collaborators

  • thiagodp