README
@locale-tools/currency
List of all currencies and a currency conversion tool.
Installation
Install a given package with npm or yarn.
npm install @locale-tools/currency
yarn add @locale-tools/currency
Usage
A full list of all circulated currencies can be found in src/data/currencies.json
.
import { currencies } from "@locale-tools/currency";
Types
// currency object type
type Currency = {
name: CurrencyNamesByISO4217 | string;
shortName: CurrencyNamesByISO4217;
iso_4217: ISO4217;
symbol: CurrencySymbolsByISO4217 | string;
subunit: string | null;
subunitToUnit: number | null;
prefix: string | null;
suffix: string | null;
decimalMark: string | null;
decimalPlaces: number | null;
thousandsSeparator: string | null;
};
// ISO4217 currency codes
enum ISO4217 {}
ISO4217.USD; // "USD"
// currency names by ISO4217 codes
enum CurrencyNamesByISO4217 {}
CurrencyNamesByISO4217.USD; // "United States Dollar"
// currency 'short' names by ISO4217
enum CurrencyShortNamesByISO4217 {}
CurrencyShortNamesByISO4217.USD; // "dollar"
// currency symbols by ISO4217
enum CurrencySymbolsByISO4217 {}
CurrencySymbolsByISO4217.USD; // "