Skip to content

Latest commit

 

History

History
105 lines (66 loc) · 2.61 KB

readme.md

File metadata and controls

105 lines (66 loc) · 2.61 KB
Raw

@brixtol/currency-symbols

Currency (ISO 4217) 3 letter code mappings to Currency symbol. used by the Brixtol Textiles internal API when dealing with currency conversion and presentation locales.

Size

Minified: 1.63 KB
Gzipped: 1.03 KB

Install

pnpm

pnpm i @brixtol/currency-symbols

npm

npm install @brixtol/currency-symbols

Yarn

yarn add @brixtol/currency-symbols

Usage

You can pass in a currency code that is lowercase, uppercase or a mixture of both.

import { getCurrencySymbol } from '@brixtol/currency-symbols';

// Currency code SEK (Krona)
const sek = getCurrencySymbol('SEK'); // Kr

// Currency code EUR (Euros)
const eur = getCurrencySymbol('eur'); // €

// Currency code USD (Dollar)
const usd = getCurrencySymbol('uSd'); // $

The module also exposes the raw mappings and interface on the export. The mappings object is provided read only using Object.freeze. The raw mappings are annotated with JSDoc comments so when using an editor that supports intellisense (ie: vscode) you will receive the country and currency name in completions and hovers.

import {
  CurrencySymbols,
  ICurrencySymbols
} from '@brixtol/currency-symbols';

// Mapping Object

CurrencySymbols.SEK; // kr
CurrencySymbols.EUR; // €
CurrencySymbols.RUB; // ₽
CurrencySymbols.USD; // $

// Interface

ICurrencySymbols.SEK; // kr
ICurrencySymbols.EUR; // €
ICurrencySymbols.RUB; // ₽
ICurrencySymbols.USD; // $

The interface is identical to the mapping.

Crypto Mappings

The module supports 4 crypto currency mappings. Only cryptos that have alt-codes are supported, please submit a PR if any are missing.

  • BTC (Bitcoin)
  • ETH (Ethereum)
  • LTL (Litecoin)
  • XBT (Bitcoin)

Related

Static GeoIP utility

Country code to currency code mappings:

Country code to country name (English) mappings:

Currency Symbol placements (use with currency.js)

License

Licensed under MIT

We ♡ open source!