react-native-format-currency 0.0.4 → 1.0.0

package/dist/format.d.ts

@@ -0,0 +1,104 @@
+import type { FormatResult, FormatResultObject, SupportedCurrency } from "./types";
+import { type CurrencyCode } from "./currencies";
+/**
+ * Clears the internal memoization cache.
+ *
+ * Use this to free memory or reset state during testing.
+ * The cache automatically evicts old entries when full (LRU with 100 entries max).
+ *
+ * @example
+ * clearFormatCache();
+ */
+export declare const clearFormatCache: () => void;
+/**
+ * Returns the current number of entries in the memoization cache.
+ *
+ * Useful for debugging or monitoring cache usage.
+ * Maximum cache size is 100 entries.
+ *
+ * @returns The number of cached format results
+ *
+ * @example
+ * console.log(getFormatCacheSize()); // 42
+ */
+export declare const getFormatCacheSize: () => number;
+/**
+ * Formats a numeric amount as a localized currency string.
+ *
+ * Supports 165+ ISO 4217 currency codes with proper symbol placement,
+ * thousands separators, and decimal formatting. Results are memoized
+ * for performance (LRU cache with 100 entries).
+ *
+ * @param options - Formatting options
+ * @param options.amount - The numeric amount to format (supports negative values)
+ * @param options.code - ISO 4217 currency code (e.g., 'USD', 'EUR', 'JPY')
+ * @param options.returnType - Optional: 'array' (default) or 'object'
+ * @returns Tuple of [formattedWithSymbol, formattedWithoutSymbol, symbol] or object with formatted, value, symbol
+ *
+ * @example
+ * // Basic usage (returns array)
+ * formatCurrency({ amount: 1234.56, code: 'USD' });
+ * // Returns: ['$1,234.56', '1,234.56', '$']
+ *
+ * @example
+ * // Object return type
+ * formatCurrency({ amount: 1234.56, code: 'USD', returnType: 'object' });
+ * // Returns: { formatted: '$1,234.56', value: '1,234.56', symbol: '$' }
+ *
+ * @example
+ * // European format (period for thousands, comma for decimals)
+ * formatCurrency({ amount: 1234.56, code: 'EUR' });
+ * // Returns: ['€1.234,56', '1.234,56', '€']
+ *
+ * @example
+ * // Zero-decimal currency
+ * formatCurrency({ amount: 1234.56, code: 'JPY' });
+ * // Returns: ['¥ 1,235', '1,235', '¥']
+ *
+ * @example
+ * // Negative amount
+ * formatCurrency({ amount: -99.99, code: 'GBP' });
+ * // Returns: ['-£99.99', '-99.99', '£']
+ *
+ * @example
+ * // Unknown currency code (returns plain number)
+ * formatCurrency({ amount: 100, code: 'XXX' });
+ * // Returns: ['100', '100', '']
+ */
+export declare function formatCurrency(options: {
+    amount: number;
+    code: CurrencyCode | string;
+}): FormatResult;
+export declare function formatCurrency(options: {
+    amount: number;
+    code: CurrencyCode | string;
+    returnType: "array";
+}): FormatResult;
+export declare function formatCurrency(options: {
+    amount: number;
+    code: CurrencyCode | string;
+    returnType: "object";
+}): FormatResultObject;
+/**
+ * Returns a list of all supported currencies.
+ *
+ * Useful for building currency selector dropdowns or validating user input.
+ * Returns 165+ currencies sorted alphabetically by code.
+ *
+ * @returns Array of objects with `code` and `name` properties
+ *
+ * @example
+ * const currencies = getSupportedCurrencies();
+ * // [
+ * //   { code: 'AED', name: 'United Arab Emirates Dirham' },
+ * //   { code: 'AFN', name: 'Afghanistan Afghani' },
+ * //   ...
+ * // ]
+ *
+ * @example
+ * // Building a dropdown
+ * getSupportedCurrencies().map(c => (
+ *   <option key={c.code} value={c.code}>{c.name}</option>
+ * ));
+ */
+export declare const getSupportedCurrencies: () => SupportedCurrency[];

package/dist/format.js

@@ -0,0 +1,142 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSupportedCurrencies = exports.getFormatCacheSize = exports.clearFormatCache = void 0;
+exports.formatCurrency = formatCurrency;
+var currencies_1 = require("./currencies");
+// Memoization cache for formatCurrency results
+var cache = new Map();
+var MAX_CACHE_SIZE = 100;
+var getCacheKey = function (amount, code) {
+    return "".concat(amount, ":").concat(code);
+};
+/**
+ * Clears the internal memoization cache.
+ *
+ * Use this to free memory or reset state during testing.
+ * The cache automatically evicts old entries when full (LRU with 100 entries max).
+ *
+ * @example
+ * clearFormatCache();
+ */
+var clearFormatCache = function () {
+    cache.clear();
+};
+exports.clearFormatCache = clearFormatCache;
+/**
+ * Returns the current number of entries in the memoization cache.
+ *
+ * Useful for debugging or monitoring cache usage.
+ * Maximum cache size is 100 entries.
+ *
+ * @returns The number of cached format results
+ *
+ * @example
+ * console.log(getFormatCacheSize()); // 42
+ */
+var getFormatCacheSize = function () { return cache.size; };
+exports.getFormatCacheSize = getFormatCacheSize;
+// Pre-compiled regex for thousands separator insertion (avoids regex creation per call)
+var THOUSANDS_REGEX = /\B(?=(\d{3})+(?!\d))/g;
+var formatNumber = function (num, format, decimals) {
+    if (!Number.isFinite(num)) {
+        return String(num);
+    }
+    var str = String(num);
+    var _a = str.split("."), intStr = _a[0], _b = _a[1], decStr = _b === void 0 ? "" : _b;
+    var thousandsSep = format === "comma" ? "," : ".";
+    var decimalSep = format === "comma" ? "." : ",";
+    var formattedInt = intStr.replace(THOUSANDS_REGEX, thousandsSep);
+    if (decimals === 0) {
+        return formattedInt;
+    }
+    var decPart = decStr.length < decimals ? decStr.padEnd(decimals, "0") : decStr;
+    return "".concat(formattedInt).concat(decimalSep).concat(decPart);
+};
+function formatCurrency(_a) {
+    var _b;
+    var amount = _a.amount, code = _a.code, returnType = _a.returnType;
+    // Helper to convert array result to object if requested
+    var toResult = function (arr) {
+        if (returnType === "object") {
+            return { formatted: arr[0], value: arr[1], symbol: arr[2] };
+        }
+        return arr;
+    };
+    // Check cache first
+    var cacheKey = getCacheKey(amount, code);
+    var cached = cache.get(cacheKey);
+    if (cached) {
+        return toResult(cached);
+    }
+    var config = currencies_1.CURRENCIES[code];
+    if (!config) {
+        var str = amount.toString();
+        var result_1 = [str, str, ""];
+        // Cache unknown currency results too
+        if (cache.size >= MAX_CACHE_SIZE) {
+            var firstKey = cache.keys().next().value;
+            if (firstKey !== undefined) {
+                cache.delete(firstKey);
+            }
+        }
+        cache.set(cacheKey, result_1);
+        return toResult(result_1);
+    }
+    var symbol = config.symbol, format = config.format, position = config.position, space = config.space;
+    var decimals = "decimals" in config ? ((_b = config.decimals) !== null && _b !== void 0 ? _b : 2) : 2;
+    var isNegative = amount < 0;
+    var absAmount = Math.abs(amount);
+    var formatted = formatNumber(absAmount, format, decimals);
+    var separator = space ? " " : "";
+    var withSymbol = position === "before"
+        ? "".concat(symbol).concat(separator).concat(formatted)
+        : "".concat(formatted).concat(separator).concat(symbol);
+    var formattedWithSign = isNegative ? "-".concat(withSymbol) : withSymbol;
+    var formattedValueWithSign = isNegative ? "-".concat(formatted) : formatted;
+    var result = [
+        formattedWithSign,
+        formattedValueWithSign,
+        symbol,
+    ];
+    // LRU eviction: remove oldest entry if cache is full
+    if (cache.size >= MAX_CACHE_SIZE) {
+        var firstKey = cache.keys().next().value;
+        if (firstKey !== undefined) {
+            cache.delete(firstKey);
+        }
+    }
+    cache.set(cacheKey, result);
+    return toResult(result);
+}
+/**
+ * Returns a list of all supported currencies.
+ *
+ * Useful for building currency selector dropdowns or validating user input.
+ * Returns 165+ currencies sorted alphabetically by code.
+ *
+ * @returns Array of objects with `code` and `name` properties
+ *
+ * @example
+ * const currencies = getSupportedCurrencies();
+ * // [
+ * //   { code: 'AED', name: 'United Arab Emirates Dirham' },
+ * //   { code: 'AFN', name: 'Afghanistan Afghani' },
+ * //   ...
+ * // ]
+ *
+ * @example
+ * // Building a dropdown
+ * getSupportedCurrencies().map(c => (
+ *   <option key={c.code} value={c.code}>{c.name}</option>
+ * ));
+ */
+var getSupportedCurrencies = function () {
+    return Object.entries(currencies_1.CURRENCIES).map(function (_a) {
+        var code = _a[0], config = _a[1];
+        return ({
+            code: code,
+            name: config.name,
+        });
+    });
+};
+exports.getSupportedCurrencies = getSupportedCurrencies;

package/dist/index.d.ts

@@ -1,11 +1,3 @@
-declare type FormatCurrencyFunction = ({ amount, code, }: {
-    amount: number;
-    code: string;
-}) => [string, number, string];
-export declare const formatCurrency: FormatCurrencyFunction;
-declare type CurrencyCode = {
-    code: string;
-    name: string;
-};
-export declare const getSupportedCurrencies: () => CurrencyCode[];
-export {};
+export type { CurrencyConfig, FormatResult, FormatResultObject, SupportedCurrency, } from "./types";
+export { CURRENCIES, type CurrencyCode } from "./currencies";
+export { formatCurrency, getSupportedCurrencies, clearFormatCache, getFormatCacheSize, } from "./format";

package/dist/index.js

@@ -1,266 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSupportedCurrencies = exports.formatCurrency = void 0;
-var formatCurrency = function (_a) {
-    var amount = _a.amount, code = _a.code;
-    var commaFormatted = String(amount).replace(/(\d)(?=(\d{3})+(?!\d))/g, "$1,");
-    var periodFormatted = String(amount)
-        .replace(".", ",")
-        .replace(/(\d)(?=(\d{3})+(?!\d))/g, "$1.");
-    var switchOptions = {
-        // argentine peso (ex: $ 1.234,56)
-        ARS: ["$ ".concat(periodFormatted), "".concat(periodFormatted), "$"],
-        // australian dollar (ex: $ 1,234.56)
-        AUD: ["$ ".concat(commaFormatted), "".concat(commaFormatted), "$"],
-        // bulgarian lev (ex: лв1,234.56)
-        BGN: ["\u043B\u0432".concat(commaFormatted), "".concat(commaFormatted), "лв"],
-        // brazilian real (ex: R$ 1.234,56)
-        BRL: ["R$ ".concat(periodFormatted), "".concat(periodFormatted), "R$"],
-        // canadian dollar (ex: $ 1,234.56)
-        CAD: ["$ ".concat(commaFormatted), "".concat(commaFormatted), "$"],
-        // swiss franc (ex: fr. 1.234,56)
-        CHF: ["fr. ".concat(periodFormatted), "".concat(periodFormatted), "fr."],
-        // chilean peso (ex: $ 1,234.56)
-        CLP: ["$ ".concat(commaFormatted), "".concat(commaFormatted), "$"],
-        // yuan renminbi (ex: ¥ 1,234.56)
-        CNY: ["\u00A5 ".concat(commaFormatted), "".concat(commaFormatted), "¥"],
-        // colombian peso (ex: $ 1,234.56)
-        COP: ["$ ".concat(commaFormatted), "".concat(commaFormatted), "$"],
-        // czech koruna (ex: 1.234,56 Kč)
-        CZK: ["".concat(periodFormatted, " K\u010D"), "".concat(periodFormatted), "Kč"],
-        // danish krone (ex: kr. 1.234,56)
-        DKK: ["kr. ".concat(periodFormatted), "".concat(periodFormatted), "kr."],
-        // european union (ex: €1.234,56)
-        EUR: ["\u20AC".concat(periodFormatted), "".concat(periodFormatted), "€"],
-        // uk/great britain pound sterling (ex: £1,234.56)
-        GBP: ["\u00A3".concat(commaFormatted), "".concat(commaFormatted), "£"],
-        // hong kong dollar (ex: HK$ 1,234.56)
-        HKD: ["HK$ ".concat(commaFormatted), "".concat(commaFormatted), "HK$"],
-        // croatian kuna (ex: 1,234.56 kn)
-        HRK: ["".concat(commaFormatted, " kn"), "".concat(commaFormatted), "kn"],
-        // hungarian forint (ex: 1.234,56 Ft)
-        HUF: ["".concat(periodFormatted, " Ft"), "".concat(periodFormatted), "Ft"],
-        // indonesian rupiah (ex: Rp 1,234.56)
-        IDR: ["Rp ".concat(commaFormatted), "".concat(commaFormatted), "Rp"],
-        // new israeli shekel (ex: ₪ 1.234,56)
-        ILS: ["\u20AA ".concat(periodFormatted), "".concat(periodFormatted), "₪"],
-        // indian rupee (ex: ₹ 1,234.56)
-        INR: ["\u20B9 ".concat(commaFormatted), "".concat(commaFormatted), "₹"],
-        // icelandic krona (ex: kr. 1.234,56)
-        ISK: ["kr. ".concat(periodFormatted), "".concat(periodFormatted), "kr."],
-        // yen (ex: ¥ 1,234.56)
-        JPY: ["\u00A5 ".concat(commaFormatted), "".concat(commaFormatted), "¥"],
-        // won (ex: ₩ 1,234.56)
-        KRW: ["\u20A9 ".concat(commaFormatted), "".concat(commaFormatted), "₩"],
-        // moroccan dirham (ex: 1,234.56 .د.م.)
-        MAD: ["".concat(commaFormatted, " .\u062F.\u0645."), "".concat(commaFormatted), ".د.م."],
-        // mexican peso (ex: $ 1,234.56)
-        MXN: ["$ ".concat(commaFormatted), "".concat(commaFormatted), "$"],
-        // malaysian ringgit (ex: RM 1,234.56)
-        MYR: ["RM ".concat(commaFormatted), "".concat(commaFormatted), "RM"],
-        // norwegian krone (ex: kr 1,234.56)
-        NOK: ["kr ".concat(commaFormatted), "".concat(commaFormatted), "kr"],
-        // new zealand dollar (ex: $ 1,234.56)
-        NZD: ["$ ".concat(commaFormatted), "".concat(commaFormatted), "$"],
-        // philippine peso (ex: ₱ 1,234.56)
-        PHP: ["\u20B1 ".concat(commaFormatted), "".concat(commaFormatted), "₱"],
-        // polish zloty (ex: 1.234,56 zł)
-        PLN: ["".concat(periodFormatted, " z\u0142"), "".concat(periodFormatted), "zł"],
-        // romanian new leu (ex: 1,234.56L)
-        RON: ["".concat(commaFormatted, "L"), "".concat(commaFormatted), "L"],
-        // russian ruble (ex: 1.234,56 p.)
-        RUB: ["".concat(periodFormatted, " p."), "".concat(periodFormatted), "p."],
-        // saudi riyal (ex: 1,234.56 ﷼)
-        SAR: ["".concat(commaFormatted, " \uFDFC"), "".concat(commaFormatted), "﷼"],
-        // swedish krona (ex: 1.234,56 kr)
-        SEK: ["".concat(periodFormatted, " kr"), "".concat(periodFormatted), "kr"],
-        // singapore dollar (ex: $1,234.56)
-        SGD: ["$".concat(commaFormatted), "".concat(commaFormatted), "$"],
-        // thai baht (ex: 1,234.56 ฿)
-        THB: ["".concat(commaFormatted, " \u0E3F"), "".concat(commaFormatted), "฿"],
-        // turkish lira (ex: 1,234.56 ₺)
-        TRY: ["".concat(commaFormatted, " \u20BA"), "".concat(commaFormatted), "₺"],
-        // new taiwan dollar (ex: 元 1,234.56)
-        TWD: ["\u5143 ".concat(commaFormatted), "".concat(commaFormatted), "元"],
-        // us dollar (ex: $1,234.56)
-        USD: ["$".concat(commaFormatted), "".concat(commaFormatted), "$"],
-        // vietnamese dong (ex: 1.234,56 ₫)
-        VND: ["".concat(periodFormatted, " \u20AB"), "".concat(periodFormatted), "₫"],
-        // south african rand (ex: R 1,234.56)
-        ZAR: ["R ".concat(commaFormatted), "".concat(commaFormatted), "R"],
-        // default
-        DEFAULT: [amount.toString(), amount.toString(), ""],
-    };
-    // TODO: fix typescript error!
-    // @ts-ignore
-    return switchOptions[code] || switchOptions.DEFAULT;
-};
-exports.formatCurrency = formatCurrency;
-var getSupportedCurrencies = function () {
-    var currencyCodes = [
-        // { code: "AED", name: "United Arab Emirates Dirham"},
-        // { code: "AFN", name: "Afghanistan Afghani"},
-        // { code: "ALL", name: "Albania Lek"},
-        // { code: "AMD", name: "Armenia Dram"},
-        // { code: "ANG", name: "Netherlands Antilles Guilder"},
-        // { code: "AOA", name: "Angola Kwanza"},
-        { code: "ARS", name: "Argentina Peso" },
-        { code: "AUD", name: "Australia Dollar" },
-        // { code: "AWG", name: "Aruba Guilder"},
-        // { code: "AZN", name: "Azerbaijan Manat"},
-        // { code: "BAM", name: "Bosnia and Herzegovina Convertible Mark"},
-        // { code: "BBD", name: "Barbados Dollar"},
-        // { code: "BDT", name: "Bangladesh Taka"},
-        { code: "BGN", name: "Bulgaria Lev" },
-        // { code: "BHD", name: "Bahrain Dinar" },
-        // { code: "BIF", name: "Burundi Franc" },
-        // { code: "BMD", name: "Bermuda Dollar" },
-        // { code: "BND", name: "Brunei Darussalam Dollar" },
-        // { code: "BOB", name: "Bolivia Bolíviano" },
-        { code: "BRL", name: "Brazil Real" },
-        // { code: "BSD", name: "Bahamas Dollar" },
-        // { code: "BTN", name: "Bhutan Ngultrum" },
-        // { code: "BWP", name: "Botswana Pula" },
-        // { code: "BYN", name: "Belarus Ruble" },
-        // { code: "BZD", name: "Belize Dollar" },
-        { code: "CAD", name: "Canada Dollar" },
-        // { code: "CDF", name: "Congo/Kinshasa Franc" },
-        { code: "CHF", name: "Switzerland Franc" },
-        { code: "CLP", name: "Chile Peso" },
-        { code: "CNY", name: "China Yuan Renminbi" },
-        { code: "COP", name: "Colombia Peso" },
-        // { code: "CRC", name: "Costa Rica Colon" },
-        // { code: "CUC", name: "Cuba Convertible Peso" },
-        // { code: "CUP", name: "Cuba Peso" },
-        // { code: "CVE", name: "Cape Verde Escudo" },
-        { code: "CZK", name: "Czech Republic Koruna" },
-        // { code: "DJF", name: "Djibouti Franc" },
-        { code: "DKK", name: "Denmark Krone" },
-        // { code: "DOP", name: "Dominican Republic Peso" },
-        // { code: "DZD", name: "Algeria Dinar" },
-        // { code: "EGP", name: "Egypt Pound" },
-        // { code: "ERN", name: "Eritrea Nakfa" },
-        // { code: "ETB", name: "Ethiopia Birr" },
-        { code: "EUR", name: "Euro Member Countries" },
-        // { code: "FJD", name: "Fiji Dollar" },
-        // { code: "FKP", name: "Falkland Islands (Malvinas) Pound" },
-        { code: "GBP", name: "United Kingdom Pound" },
-        // { code: "GEL", name: "Georgia Lari" },
-        // { code: "GGP", name: "Guernsey Pound" },
-        // { code: "GHS", name: "Ghana Cedi" },
-        // { code: "GIP", name: "Gibraltar Pound" },
-        // { code: "GMD", name: "Gambia Dalasi" },
-        // { code: "GNF", name: "Guinea Franc" },
-        // { code: "GTQ", name: "Guatemala Quetzal" },
-        // { code: "GTQ", name: "Guyana Dollar" },
-        { code: "HKD", name: "Hong Kong Dollar" },
-        // { code: "HNL", name: "Honduras Lempira" },
-        { code: "HRK", name: "Croatia Kuna" },
-        // { code: "HTG", name: "Haiti Gourde" },
-        { code: "HUF", name: "Hungary Forint" },
-        { code: "IDR", name: "Indonesia Rupiah" },
-        { code: "ILS", name: "Israel Shekel" },
-        // { code: "IMP", name: "Isle of Man Pound" },
-        { code: "INR", name: "India Rupee" },
-        // { code: "IQD", name: "Iraq Dinar" },
-        // { code: "IRR", name: "Iran Rial" },
-        { code: "ISK", name: "Iceland Krona" },
-        // { code: "JEP", name: "Jersey Pound" },
-        // { code: "JMD", name: "Jamaica Dollar" },
-        // { code: "JOD", name: "Jordan Dinar" },
-        { code: "JPY", name: "Japan Yen" },
-        // { code: "KES", name: "Kenya Shilling" },
-        // { code: "KGS", name: "Kyrgyzstan Som" },
-        // { code: "KHR", name: "Cambodia Riel" },
-        // { code: "KMF", name: "Comorian Franc" },
-        // { code: "KPW", name: "Korea (North) Won" },
-        { code: "KRW", name: "Korea (South) Won" },
-        // { code: "KWD", name: "Kuwait Dinar" },
-        // { code: "KYD", name: "Cayman Islands Dollar" },
-        // { code: "KZT", name: "Kazakhstan Tenge" },
-        // { code: "LAK", name: "Laos Kip" },
-        // { code: "LPB", name: "Lebanon Pound" },
-        // { code: "LKR", name: "Sri Lanka Rupee" },
-        // { code: "LRD", name: "Liberia Dollar" },
-        // { code: "LSL", name: "Lesotho Loti" },
-        // { code: "LYD", name: "Libya Dinar" },
-        { code: "MAD", name: "Morocco Dirham" },
-        // { code: "MDL", name: "Moldova Leu" },
-        // { code: "MGA", name: "Madagascar Ariary" },
-        // { code: "MKD", name: "Macedonia Denar" },
-        // { code: "MMK", name: "Myanmar (Burma) Kyat" },
-        // { code: "MNT", name: "Mongolia Tughrik" },
-        // { code: "MOP", name: "Macau Pataca" },
-        // { code: "MRU", name: "Mauritania Ouguiya" },
-        // { code: "MUR", name: "Mauritius Rupee" },
-        // { code: "MVR", name: "Maldives (Maldive Islands) Rufiyaa" },
-        // { code: "MWK", name: "Malawi Kwacha" },
-        { code: "MXN", name: "Mexico Peso" },
-        { code: "MYR", name: "Malaysia Ringgit" },
-        // { code: "MZN", name: "Mozambique Metical" },
-        // { code: "NAD", name: "Namibia Dollar" },
-        // { code: "NGN", name: "Nigeria Naira" },
-        // { code: "NIO", name: "Nicaragua Cordoba" },
-        { code: "NOK", name: "Norway Krone" },
-        // { code: "NPR", name: "Nepal Rupee" },
-        { code: "NZD", name: "New Zealand Dollar" },
-        // { code: "OMR", name: "Oman Rial" },
-        // { code: "PAB", name: "Panama Balboa" },
-        // { code: "PEN", name: "Peru Sol" },
-        // { code: "PGK", name: "Papua New Guinea Kina" },
-        { code: "PHP", name: "Philippines Peso" },
-        // { code: "PKR", name: "Pakistan Rupee" },
-        { code: "PLN", name: "Poland Zloty" },
-        // { code: "PYG", name: "Paraguay Guarani" },
-        // { code: "QAR", name: "Qatar Riyal" },
-        { code: "RON", name: "Romania Leu" },
-        // { code: "RSD", name: "Serbia Dinar" },
-        { code: "RUB", name: "Russia Ruble" },
-        // { code: "RWF", name: "Rwanda Franc" },
-        { code: "SAR", name: "Saudi Arabia Riyal" },
-        // { code: "SBD", name: "Solomon Islands Dollar" },
-        // { code: "SCR", name: "Seychelles Rupee" },
-        // { code: "SDG", name: "Sudan Pound" },
-        { code: "SEK", name: "Sweden Krona" },
-        { code: "SGD", name: "Singapore Dollar" },
-        // { code: "SHP", name: "Saint Helena Pound" },
-        // { code: "SLL", name: "Sierra Leone Leone" },
-        // { code: "SOS", name: "Somalia Shilling" },
-        // { code: "SPL", name: "Seborga Luigino" },
-        // { code: "SRD", name: "Suriname Dollar" },
-        // { code: "STN", name: "São Tomé and Príncipe Dobra" },
-        // { code: "SVC", name: "El Salvador Colon" },
-        // { code: "SYP", name: "Syria Pound" },
-        // { code: "SZL", name: "eSwatini Lilangeni" },
-        { code: "THB", name: "Thailand Baht" },
-        // { code: "TJS", name: "Tajikistan Somoni" },
-        // { code: "TMT", name: "Turkmenistan Manat" },
-        // { code: "TND", name: "Tunisia Dinar" },
-        // { code: "TOP", name: "Tonga Pa'anga" },
-        { code: "TRY", name: "Turkey Lira" },
-        // { code: "TTD", name: "Trinidad and Tobago Dollar" },
-        // { code: "TVD", name: "Tuvalu Dollar" },
-        { code: "TWD", name: "Taiwan New Dollar" },
-        // { code: "TZS", name: "Tanzania Shilling" },
-        // { code: "UAH", name: "Ukraine Hryvnia" },
-        // { code: "UGX", name: "Uganda Shilling" },
-        { code: "USD", name: "United States Dollar" },
-        // { code: "UYU", name: "Uruguay Peso" },
-        // { code: "UZS", name: "Uzbekistan Som" },
-        // { code: "VEF", name: "Venezuela Bolívar" },
-        { code: "VND", name: "Viet Nam Dong" },
-        // { code: "VUV", name: "Vanuatu Vatu" },
-        // { code: "WST", name: "Samoa Tala" },
-        // { code: "XAF", name: "Communauté Financière Africaine (BEAC) CFA Franc BEAC" },
-        // { code: "XCD", name: "East Caribbean Dollar" },
-        // { code: "XDR", name: "International Monetary Fund (IMF) Special Drawing Rights" },
-        // { code: "XOF", name: "Communauté Financière Africaine (BCEAO) Franc" },
-        // { code: "XPF", name: "Comptoirs Français du Pacifique (CFP) Franc" },
-        // { code: "YER", name: "Yemen Rial" },
-        { code: "ZAR", name: "South Africa Rand" },
-        // { code: "ZMW", name: "Zambia Kwacha" },
-        // { code: "ZWD", name: "Zimbabwe Dollar" },
-    ];
-    return currencyCodes;
-};
-exports.getSupportedCurrencies = getSupportedCurrencies;
+exports.getFormatCacheSize = exports.clearFormatCache = exports.getSupportedCurrencies = exports.formatCurrency = exports.CURRENCIES = void 0;
+// Currency data and codes
+var currencies_1 = require("./currencies");
+Object.defineProperty(exports, "CURRENCIES", { enumerable: true, get: function () { return currencies_1.CURRENCIES; } });
+// Formatting functions
+var format_1 = require("./format");
+Object.defineProperty(exports, "formatCurrency", { enumerable: true, get: function () { return format_1.formatCurrency; } });
+Object.defineProperty(exports, "getSupportedCurrencies", { enumerable: true, get: function () { return format_1.getSupportedCurrencies; } });
+Object.defineProperty(exports, "clearFormatCache", { enumerable: true, get: function () { return format_1.clearFormatCache; } });
+Object.defineProperty(exports, "getFormatCacheSize", { enumerable: true, get: function () { return format_1.getFormatCacheSize; } });

package/dist/types.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Configuration for a currency's formatting rules.
+ *
+ * @property name - Full name of the currency (e.g., "United States Dollar")
+ * @property symbol - Currency symbol or code (e.g., "$", "€", "USD")
+ * @property format - Thousands/decimal separator style: "comma" (1,234.56) or "period" (1.234,56)
+ * @property position - Symbol placement: "before" ($100) or "after" (100€)
+ * @property space - Whether to include a space between symbol and amount
+ * @property decimals - Number of decimal places (defaults to 2 if not specified)
+ */
+export type CurrencyConfig = {
+    name: string;
+    symbol: string;
+    format: "comma" | "period";
+    position: "before" | "after";
+    space: boolean;
+    decimals?: number;
+};
+/**
+ * Return type for formatCurrency function (array format).
+ *
+ * A tuple containing three strings:
+ * - [0] Formatted amount with currency symbol (e.g., "$1,234.56")
+ * - [1] Formatted amount without symbol (e.g., "1,234.56")
+ * - [2] Currency symbol only (e.g., "$")
+ *
+ * @example
+ * const [withSymbol, withoutSymbol, symbol] = formatCurrency({ amount: 1234.56, code: 'USD' });
+ * // withSymbol: "$1,234.56"
+ * // withoutSymbol: "1,234.56"
+ * // symbol: "$"
+ */
+export type FormatResult = [string, string, string];
+/**
+ * Return type for formatCurrency function (object format).
+ *
+ * An object containing the formatted currency values:
+ * - formatted: Formatted amount with currency symbol (e.g., "$1,234.56")
+ * - value: Formatted amount without symbol (e.g., "1,234.56")
+ * - symbol: Currency symbol only (e.g., "$")
+ *
+ * @example
+ * const result = formatCurrency({ amount: 1234.56, code: 'USD', returnType: 'object' });
+ * // result.formatted: "$1,234.56"
+ * // result.value: "1,234.56"
+ * // result.symbol: "$"
+ */
+export type FormatResultObject = {
+    formatted: string;
+    value: string;
+    symbol: string;
+};
+/**
+ * Represents a supported currency with its code and display name.
+ */
+export type SupportedCurrency = {
+    /** ISO 4217 currency code (e.g., "USD", "EUR") */
+    code: string;
+    /** Full currency name (e.g., "United States Dollar") */
+    name: string;
+};

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });