2.0.2 • Published 7 months ago

country-to-currency v2.0.2

Weekly downloads
53
License
MIT
Repository
github
Last release
7 months ago

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.

👉 Examples available in the folder examples.

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 using 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/index.cjs' ); // '/index.cjs' needed since version 2.0
console.log( countryToCurrency[ 'US' ] ); // USD

Deno

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

Notes

  • Countries included: 251
    • Imported: 249
    • Included: 2
    • Fixed: 17
  • Currencies assumed:
CountryCurrencyDetailsThanks to
Antarctica (AQ)USDAntarctica has no official currency@thiagodp
Palestine (PS)ILSGoogle@thiagodp
Turkey (TR)TRYWikipedia@kylem123, @thiagodp
South Korea (KR)KRWISO 4217@MunjaeLee, @thiagodp
Switzerland (CH)CHFWikipedia@betabong, @thiagodp
Chile (CL)CLPCLF is a non-circulating currency. Wikipedia@thiagodp
Uruguay (UY)UYUWikipedia@marneborn, @thiagodp
Croatia (HR)EURSince January 1st, 2023. Wikipedia and Stripe@xaphod, @thiagodp
Netherlands Antilles (AN)ANGISO 4217@jayPare, @thiagodp
El Salvador (SV)USDSince 2001. Wikipedia@chaitanya-d, @thiagodp
South Georgia and the South Sandwich Islands (GS)FKPWikipedia and https://gov.gs@danielrentz, @thiagodp
Cuba (CU)CUPWikipedia@jasongitmail, @thiagodp
Hungary (HU)HUFWikipedia@jasongitmail, @thiagodp
Samoa (WS)WSTWikipedia@jasongitmail, @thiagodp
Niger (NE)XOFWikipedia@danielrentz, @thiagodp
Republic of the Congo (CG)XAFWikipedia@jasongitmail, @thiagodp
Dominican Republic (DM)XCDWikipedia@jasongitmail, @thiagodp
Sierra Leone (SL)SLEWikipedia and European Union@jasongitmail, @thiagodp
Kosovo (XK)EURWikipedia and Geo Names@dukesilverr, @thiagodp

Contribute

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, fixes, offers support to browsers and DenoJS, updates dependencies, and provides new internal scripts.

MIT © Thiago Delgado Pinto

2.0.2

7 months ago

2.0.1

8 months ago

2.0.0

8 months ago

1.1.5

1 year ago

1.1.4

1 year ago

1.1.3

1 year ago

1.1.2

1 year ago

1.1.1

2 years ago

1.1.0

2 years ago

1.0.12

2 years ago

1.0.11

2 years ago

1.0.9

2 years ago

1.0.10

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

1.0.6

3 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

4 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago