@coingecko/cryptoformat 0.5.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();
 
@@ -187,6 +204,7 @@ 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
@@ -227,6 +245,9 @@ function initializeFormatters(isoCode, locale) {
   currencyFormatter18DP = cachedFormatter
     ? cachedFormatter.currencyFormatter18DP
     : generateFormatter(isoCode, locale, 18);
+  currencyFormatterAbbreviated = cachedFormatter
+    ? cachedFormatter.currencyFormatterAbbreviated
+    : generateAbbreviatedFormatter(isoCode, locale);
 
   // Save in cache
   if (cachedFormatter == null) {
@@ -240,6 +261,7 @@ function initializeFormatters(isoCode, locale) {
     formattersCache[cacheKey].currencyFormatterVeryVerySmall = currencyFormatterVeryVerySmall;
     formattersCache[cacheKey].currencyFormatter15DP = currencyFormatter15DP;
     formattersCache[cacheKey].currencyFormatter18DP = currencyFormatter18DP;
+    formattersCache[cacheKey].currencyFormatterAbbreviated = currencyFormatterAbbreviated;
   }
 }
 
@@ -255,7 +277,8 @@ function formatCurrency(
   isoCode,
   locale = "en",
   raw = false,
-  noDecimal = false
+  noDecimal = false,
+  abbreviated = false,
 ) {
   isoCode = isoCode.toUpperCase();
 
@@ -267,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),

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();
 
@@ -183,6 +200,7 @@ 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
@@ -223,6 +241,9 @@ function initializeFormatters(isoCode, locale) {
   currencyFormatter18DP = cachedFormatter
     ? cachedFormatter.currencyFormatter18DP
     : generateFormatter(isoCode, locale, 18);
+  currencyFormatterAbbreviated = cachedFormatter
+    ? cachedFormatter.currencyFormatterAbbreviated
+    : generateAbbreviatedFormatter(isoCode, locale);
 
   // Save in cache
   if (cachedFormatter == null) {
@@ -236,6 +257,7 @@ function initializeFormatters(isoCode, locale) {
     formattersCache[cacheKey].currencyFormatterVeryVerySmall = currencyFormatterVeryVerySmall;
     formattersCache[cacheKey].currencyFormatter15DP = currencyFormatter15DP;
     formattersCache[cacheKey].currencyFormatter18DP = currencyFormatter18DP;
+    formattersCache[cacheKey].currencyFormatterAbbreviated = currencyFormatterAbbreviated;
   }
 }
 
@@ -251,7 +273,8 @@ function formatCurrency(
   isoCode,
   locale = "en",
   raw = false,
-  noDecimal = false
+  noDecimal = false,
+  abbreviated = false,
 ) {
   isoCode = isoCode.toUpperCase();
 
@@ -263,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),

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();
 
@@ -189,6 +206,7 @@
   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
@@ -229,6 +247,9 @@
     currencyFormatter18DP = cachedFormatter
       ? cachedFormatter.currencyFormatter18DP
       : generateFormatter(isoCode, locale, 18);
+    currencyFormatterAbbreviated = cachedFormatter
+      ? cachedFormatter.currencyFormatterAbbreviated
+      : generateAbbreviatedFormatter(isoCode, locale);
 
     // Save in cache
     if (cachedFormatter == null) {
@@ -242,6 +263,7 @@
       formattersCache[cacheKey].currencyFormatterVeryVerySmall = currencyFormatterVeryVerySmall;
       formattersCache[cacheKey].currencyFormatter15DP = currencyFormatter15DP;
       formattersCache[cacheKey].currencyFormatter18DP = currencyFormatter18DP;
+      formattersCache[cacheKey].currencyFormatterAbbreviated = currencyFormatterAbbreviated;
     }
   }
 
@@ -257,7 +279,8 @@
     isoCode,
     locale = "en",
     raw = false,
-    noDecimal = false
+    noDecimal = false,
+    abbreviated = false,
   ) {
     isoCode = isoCode.toUpperCase();
 
@@ -269,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),

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.5.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",