@coingecko/cryptoformat 0.4.4 → 0.6.0

package/lib/cryptoformat.cjs.js

@@ -165,6 +165,23 @@ function generateFallbackFormatter(isoCode, locale, numDecimals = 2) {
   }
 }
 
+function generateAbbreviatedFormatter(isoCode, locale) {
+  // Show regular numbers if no Intl.NumberFormat support.
+  if (!IntlNumberFormatSupported()) {
+    return generateFallbackFormatter(isoCode, locale, 0);
+  }
+
+  let numberFormatOptions = { style: "decimal", notation: "compact", minimumFractionDigits: 0, maximumFractionDigits: 2 };
+
+  // Currency symbol is supported if currency is Fiat/BTC/ETH.
+  if (!isCrypto(isoCode) || isBTCETH(isoCode)) {
+    numberFormatOptions.style = "currency";
+    numberFormatOptions.currency = isoCode;
+  }
+
+  return new Intl.NumberFormat(locale, numberFormatOptions);
+}
+
 function generateFormatter(isoCode, locale, numDecimals, numSigFig) {
   const isNumberFormatSupported = IntlNumberFormatSupported();
 
@@ -185,6 +202,9 @@ let currencyFormatterTwoDecimal;
 let currencyFormatterSmall;
 let currencyFormatterVerySmall;
 let currencyFormatterVeryVerySmall;
+let currencyFormatter15DP;
+let currencyFormatter18DP;
+let currencyFormatterAbbreviated;
 
 // If a page has to display multiple currencies, formatters would have to be created for each of them
 // To save some effort, we save formatters for reuse
@@ -219,6 +239,15 @@ function initializeFormatters(isoCode, locale) {
   currencyFormatterVeryVerySmall = cachedFormatter
     ? cachedFormatter.currencyFormatterVeryVerySmall
     : generateFormatter(isoCode, locale, 12);
+  currencyFormatter15DP = cachedFormatter
+    ? cachedFormatter.currencyFormatter15DP
+    : generateFormatter(isoCode, locale, 15);
+  currencyFormatter18DP = cachedFormatter
+    ? cachedFormatter.currencyFormatter18DP
+    : generateFormatter(isoCode, locale, 18);
+  currencyFormatterAbbreviated = cachedFormatter
+    ? cachedFormatter.currencyFormatterAbbreviated
+    : generateAbbreviatedFormatter(isoCode, locale);
 
   // Save in cache
   if (cachedFormatter == null) {
@@ -230,6 +259,9 @@ function initializeFormatters(isoCode, locale) {
     formattersCache[cacheKey].currencyFormatterSmall = currencyFormatterSmall;
     formattersCache[cacheKey].currencyFormatterVerySmall = currencyFormatterVerySmall;
     formattersCache[cacheKey].currencyFormatterVeryVerySmall = currencyFormatterVeryVerySmall;
+    formattersCache[cacheKey].currencyFormatter15DP = currencyFormatter15DP;
+    formattersCache[cacheKey].currencyFormatter18DP = currencyFormatter18DP;
+    formattersCache[cacheKey].currencyFormatterAbbreviated = currencyFormatterAbbreviated;
   }
 }
 
@@ -245,7 +277,8 @@ function formatCurrency(
   isoCode,
   locale = "en",
   raw = false,
-  noDecimal = false
+  noDecimal = false,
+  abbreviated = false,
 ) {
   isoCode = isoCode.toUpperCase();
 
@@ -257,6 +290,17 @@ function formatCurrency(
     initializeFormatters(isoCode, locale);
   }
 
+  if (abbreviated) {
+    let formattedAbbreviatedCurrency = currencyFormatterAbbreviated.format(amount);
+
+    // Manually add currency code to the back for non-BTC/ETH crypto currencies.
+    if (isCrypto(isoCode) && !isBTCETH(isoCode)) {
+      formattedAbbreviatedCurrency = `${formattedAbbreviatedCurrency} ${isoCode}`;
+    }
+
+    return formatCurrencyOverride(formattedAbbreviatedCurrency, locale);
+  }
+
   if (noDecimal === true && amount > 100.0) {
     return formatCurrencyOverride(
       currencyFormatterNoDecimal.format(amount),
@@ -345,19 +389,32 @@ function formatCurrency(
         currencyFormatterVerySmall.format(amount),
         locale
       );
-    } else {
-      // Crypto amount < 0.000001, show 12 fraction digits
+    } else if (price >= 10**-9 && price < 10**-6) {
       return formatCurrencyOverride(
         currencyFormatterVeryVerySmall.format(amount),
         locale
       );
+    } else if (price >= 10**-12 && price < 10**-9) {
+      return formatCurrencyOverride(
+        currencyFormatter15DP.format(amount),
+        locale
+      );
+    } else if (price < 10**-12) {
+      return formatCurrencyOverride(
+        currencyFormatter18DP.format(amount),
+        locale
+      );
     }
   } else {
     const unsigned_amount = Math.abs(amount);
     if (raw) {
-      if (unsigned_amount < 0.00001) {
+      if (unsigned_amount < 10**-12) {
+        return amount.toFixed(18);
+      } else if (unsigned_amount < 10**-9) {
+        return amount.toFixed(15);
+      } else if (unsigned_amount < 10**-6) {
         return amount.toFixed(12);
-      } else if (unsigned_amount < 0.001) {
+      } else if (unsigned_amount < 10**-3) {
         return amount.toFixed(8);
       } else if (unsigned_amount < 1.0) {
         return amount.toFixed(6);
@@ -371,7 +428,17 @@ function formatCurrency(
         currencyFormatterNormal.format(amount),
         locale
       );
-    } else if (unsigned_amount < 0.000001) {
+    } else if (unsigned_amount < 10**-12) {
+      return formatCurrencyOverride(
+        currencyFormatter18DP.format(amount),
+        locale
+      );
+    } else if (unsigned_amount < 10**-9) {
+      return formatCurrencyOverride(
+        currencyFormatter15DP.format(amount),
+        locale
+      );
+    } else if (unsigned_amount < 10**-6) {
       return formatCurrencyOverride(
         currencyFormatterVeryVerySmall.format(amount),
         locale

package/lib/cryptoformat.esm.js

@@ -161,6 +161,23 @@ function generateFallbackFormatter(isoCode, locale, numDecimals = 2) {
   }
 }
 
+function generateAbbreviatedFormatter(isoCode, locale) {
+  // Show regular numbers if no Intl.NumberFormat support.
+  if (!IntlNumberFormatSupported()) {
+    return generateFallbackFormatter(isoCode, locale, 0);
+  }
+
+  let numberFormatOptions = { style: "decimal", notation: "compact", minimumFractionDigits: 0, maximumFractionDigits: 2 };
+
+  // Currency symbol is supported if currency is Fiat/BTC/ETH.
+  if (!isCrypto(isoCode) || isBTCETH(isoCode)) {
+    numberFormatOptions.style = "currency";
+    numberFormatOptions.currency = isoCode;
+  }
+
+  return new Intl.NumberFormat(locale, numberFormatOptions);
+}
+
 function generateFormatter(isoCode, locale, numDecimals, numSigFig) {
   const isNumberFormatSupported = IntlNumberFormatSupported();
 
@@ -181,6 +198,9 @@ let currencyFormatterTwoDecimal;
 let currencyFormatterSmall;
 let currencyFormatterVerySmall;
 let currencyFormatterVeryVerySmall;
+let currencyFormatter15DP;
+let currencyFormatter18DP;
+let currencyFormatterAbbreviated;
 
 // If a page has to display multiple currencies, formatters would have to be created for each of them
 // To save some effort, we save formatters for reuse
@@ -215,6 +235,15 @@ function initializeFormatters(isoCode, locale) {
   currencyFormatterVeryVerySmall = cachedFormatter
     ? cachedFormatter.currencyFormatterVeryVerySmall
     : generateFormatter(isoCode, locale, 12);
+  currencyFormatter15DP = cachedFormatter
+    ? cachedFormatter.currencyFormatter15DP
+    : generateFormatter(isoCode, locale, 15);
+  currencyFormatter18DP = cachedFormatter
+    ? cachedFormatter.currencyFormatter18DP
+    : generateFormatter(isoCode, locale, 18);
+  currencyFormatterAbbreviated = cachedFormatter
+    ? cachedFormatter.currencyFormatterAbbreviated
+    : generateAbbreviatedFormatter(isoCode, locale);
 
   // Save in cache
   if (cachedFormatter == null) {
@@ -226,6 +255,9 @@ function initializeFormatters(isoCode, locale) {
     formattersCache[cacheKey].currencyFormatterSmall = currencyFormatterSmall;
     formattersCache[cacheKey].currencyFormatterVerySmall = currencyFormatterVerySmall;
     formattersCache[cacheKey].currencyFormatterVeryVerySmall = currencyFormatterVeryVerySmall;
+    formattersCache[cacheKey].currencyFormatter15DP = currencyFormatter15DP;
+    formattersCache[cacheKey].currencyFormatter18DP = currencyFormatter18DP;
+    formattersCache[cacheKey].currencyFormatterAbbreviated = currencyFormatterAbbreviated;
   }
 }
 
@@ -241,7 +273,8 @@ function formatCurrency(
   isoCode,
   locale = "en",
   raw = false,
-  noDecimal = false
+  noDecimal = false,
+  abbreviated = false,
 ) {
   isoCode = isoCode.toUpperCase();
 
@@ -253,6 +286,17 @@ function formatCurrency(
     initializeFormatters(isoCode, locale);
   }
 
+  if (abbreviated) {
+    let formattedAbbreviatedCurrency = currencyFormatterAbbreviated.format(amount);
+
+    // Manually add currency code to the back for non-BTC/ETH crypto currencies.
+    if (isCrypto(isoCode) && !isBTCETH(isoCode)) {
+      formattedAbbreviatedCurrency = `${formattedAbbreviatedCurrency} ${isoCode}`;
+    }
+
+    return formatCurrencyOverride(formattedAbbreviatedCurrency, locale);
+  }
+
   if (noDecimal === true && amount > 100.0) {
     return formatCurrencyOverride(
       currencyFormatterNoDecimal.format(amount),
@@ -341,19 +385,32 @@ function formatCurrency(
         currencyFormatterVerySmall.format(amount),
         locale
       );
-    } else {
-      // Crypto amount < 0.000001, show 12 fraction digits
+    } else if (price >= 10**-9 && price < 10**-6) {
       return formatCurrencyOverride(
         currencyFormatterVeryVerySmall.format(amount),
         locale
       );
+    } else if (price >= 10**-12 && price < 10**-9) {
+      return formatCurrencyOverride(
+        currencyFormatter15DP.format(amount),
+        locale
+      );
+    } else if (price < 10**-12) {
+      return formatCurrencyOverride(
+        currencyFormatter18DP.format(amount),
+        locale
+      );
     }
   } else {
     const unsigned_amount = Math.abs(amount);
     if (raw) {
-      if (unsigned_amount < 0.00001) {
+      if (unsigned_amount < 10**-12) {
+        return amount.toFixed(18);
+      } else if (unsigned_amount < 10**-9) {
+        return amount.toFixed(15);
+      } else if (unsigned_amount < 10**-6) {
         return amount.toFixed(12);
-      } else if (unsigned_amount < 0.001) {
+      } else if (unsigned_amount < 10**-3) {
         return amount.toFixed(8);
       } else if (unsigned_amount < 1.0) {
         return amount.toFixed(6);
@@ -367,7 +424,17 @@ function formatCurrency(
         currencyFormatterNormal.format(amount),
         locale
       );
-    } else if (unsigned_amount < 0.000001) {
+    } else if (unsigned_amount < 10**-12) {
+      return formatCurrencyOverride(
+        currencyFormatter18DP.format(amount),
+        locale
+      );
+    } else if (unsigned_amount < 10**-9) {
+      return formatCurrencyOverride(
+        currencyFormatter15DP.format(amount),
+        locale
+      );
+    } else if (unsigned_amount < 10**-6) {
       return formatCurrencyOverride(
         currencyFormatterVeryVerySmall.format(amount),
         locale

package/lib/cryptoformat.umd.js

@@ -167,6 +167,23 @@
     }
   }
 
+  function generateAbbreviatedFormatter(isoCode, locale) {
+    // Show regular numbers if no Intl.NumberFormat support.
+    if (!IntlNumberFormatSupported()) {
+      return generateFallbackFormatter(isoCode, locale, 0);
+    }
+
+    let numberFormatOptions = { style: "decimal", notation: "compact", minimumFractionDigits: 0, maximumFractionDigits: 2 };
+
+    // Currency symbol is supported if currency is Fiat/BTC/ETH.
+    if (!isCrypto(isoCode) || isBTCETH(isoCode)) {
+      numberFormatOptions.style = "currency";
+      numberFormatOptions.currency = isoCode;
+    }
+
+    return new Intl.NumberFormat(locale, numberFormatOptions);
+  }
+
   function generateFormatter(isoCode, locale, numDecimals, numSigFig) {
     const isNumberFormatSupported = IntlNumberFormatSupported();
 
@@ -187,6 +204,9 @@
   let currencyFormatterSmall;
   let currencyFormatterVerySmall;
   let currencyFormatterVeryVerySmall;
+  let currencyFormatter15DP;
+  let currencyFormatter18DP;
+  let currencyFormatterAbbreviated;
 
   // If a page has to display multiple currencies, formatters would have to be created for each of them
   // To save some effort, we save formatters for reuse
@@ -221,6 +241,15 @@
     currencyFormatterVeryVerySmall = cachedFormatter
       ? cachedFormatter.currencyFormatterVeryVerySmall
       : generateFormatter(isoCode, locale, 12);
+    currencyFormatter15DP = cachedFormatter
+      ? cachedFormatter.currencyFormatter15DP
+      : generateFormatter(isoCode, locale, 15);
+    currencyFormatter18DP = cachedFormatter
+      ? cachedFormatter.currencyFormatter18DP
+      : generateFormatter(isoCode, locale, 18);
+    currencyFormatterAbbreviated = cachedFormatter
+      ? cachedFormatter.currencyFormatterAbbreviated
+      : generateAbbreviatedFormatter(isoCode, locale);
 
     // Save in cache
     if (cachedFormatter == null) {
@@ -232,6 +261,9 @@
       formattersCache[cacheKey].currencyFormatterSmall = currencyFormatterSmall;
       formattersCache[cacheKey].currencyFormatterVerySmall = currencyFormatterVerySmall;
       formattersCache[cacheKey].currencyFormatterVeryVerySmall = currencyFormatterVeryVerySmall;
+      formattersCache[cacheKey].currencyFormatter15DP = currencyFormatter15DP;
+      formattersCache[cacheKey].currencyFormatter18DP = currencyFormatter18DP;
+      formattersCache[cacheKey].currencyFormatterAbbreviated = currencyFormatterAbbreviated;
     }
   }
 
@@ -247,7 +279,8 @@
     isoCode,
     locale = "en",
     raw = false,
-    noDecimal = false
+    noDecimal = false,
+    abbreviated = false,
   ) {
     isoCode = isoCode.toUpperCase();
 
@@ -259,6 +292,17 @@
       initializeFormatters(isoCode, locale);
     }
 
+    if (abbreviated) {
+      let formattedAbbreviatedCurrency = currencyFormatterAbbreviated.format(amount);
+
+      // Manually add currency code to the back for non-BTC/ETH crypto currencies.
+      if (isCrypto(isoCode) && !isBTCETH(isoCode)) {
+        formattedAbbreviatedCurrency = `${formattedAbbreviatedCurrency} ${isoCode}`;
+      }
+
+      return formatCurrencyOverride(formattedAbbreviatedCurrency, locale);
+    }
+
     if (noDecimal === true && amount > 100.0) {
       return formatCurrencyOverride(
         currencyFormatterNoDecimal.format(amount),
@@ -347,19 +391,32 @@
           currencyFormatterVerySmall.format(amount),
           locale
         );
-      } else {
-        // Crypto amount < 0.000001, show 12 fraction digits
+      } else if (price >= 10**-9 && price < 10**-6) {
         return formatCurrencyOverride(
           currencyFormatterVeryVerySmall.format(amount),
           locale
         );
+      } else if (price >= 10**-12 && price < 10**-9) {
+        return formatCurrencyOverride(
+          currencyFormatter15DP.format(amount),
+          locale
+        );
+      } else if (price < 10**-12) {
+        return formatCurrencyOverride(
+          currencyFormatter18DP.format(amount),
+          locale
+        );
       }
     } else {
       const unsigned_amount = Math.abs(amount);
       if (raw) {
-        if (unsigned_amount < 0.00001) {
+        if (unsigned_amount < 10**-12) {
+          return amount.toFixed(18);
+        } else if (unsigned_amount < 10**-9) {
+          return amount.toFixed(15);
+        } else if (unsigned_amount < 10**-6) {
           return amount.toFixed(12);
-        } else if (unsigned_amount < 0.001) {
+        } else if (unsigned_amount < 10**-3) {
           return amount.toFixed(8);
         } else if (unsigned_amount < 1.0) {
           return amount.toFixed(6);
@@ -373,7 +430,17 @@
           currencyFormatterNormal.format(amount),
           locale
         );
-      } else if (unsigned_amount < 0.000001) {
+      } else if (unsigned_amount < 10**-12) {
+        return formatCurrencyOverride(
+          currencyFormatter18DP.format(amount),
+          locale
+        );
+      } else if (unsigned_amount < 10**-9) {
+        return formatCurrencyOverride(
+          currencyFormatter15DP.format(amount),
+          locale
+        );
+      } else if (unsigned_amount < 10**-6) {
         return formatCurrencyOverride(
           currencyFormatterVeryVerySmall.format(amount),
           locale

package/lib/index.d.ts

@@ -24,8 +24,16 @@ export function formatCurrency(
   raw: boolean,
   noDecimal: boolean | decimalConfig
 ): string;
+export function formatCurrency(
+  amount: number,
+  isoCode: string,
+  locale: string,
+  raw: boolean,
+  noDecimal: boolean | decimalConfig,
+  abbreviated: boolean,
+): string;
 
 interface decimalConfig {
   decimalPlaces?: number, 
   significantFigures?: number 
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coingecko/cryptoformat",
-  "version": "0.4.4",
+  "version": "0.6.0",
   "description": "Javascript library to format and display cryptocurrencies and fiat",
   "main": "lib/cryptoformat.cjs.js",
   "module": "lib/cryptoformat.esm.js",