@cloudflare/util-formatters 2.7.0 → 2.7.3

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.7.3](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-formatters@2.7.2...@cloudflare/util-formatters@2.7.3) (2022-04-12)
+
+**Note:** Version bump only for package @cloudflare/util-formatters
+
+
+
+
+
+## [2.7.2](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-formatters@2.7.1...@cloudflare/util-formatters@2.7.2) (2022-02-14)
+
+**Note:** Version bump only for package @cloudflare/util-formatters
+
+
+
+
+
+## [2.7.1](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-formatters@2.7.0...@cloudflare/util-formatters@2.7.1) (2021-12-06)
+
+**Note:** Version bump only for package @cloudflare/util-formatters
+
+
+
+
+
 # [2.7.0](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-formatters@2.6.15...@cloudflare/util-formatters@2.7.0) (2021-11-29)
 
 

package/dist/formatters.d.ts

@@ -48,7 +48,7 @@ export declare const formatCurrency: (value?: CurrencyValue, options?: CurrencyO
  * @param {Boolean} [includeDecimals]
  * @return {String}
  */
-export declare const formatBytes: (number: number, locale: SupportedLocales | undefined, includeDecimals: boolean) => string;
+export declare const formatBytes: (number: number, locale: SupportedLocales | undefined, includeDecimals: boolean, useBytes?: boolean) => string;
 /**
  * @param {Number} number
  * @param {String} locale
@@ -68,3 +68,4 @@ export declare const formatBits: (number: number, locale: SupportedLocales | und
 export declare const formatNumberForAnalytics: (number: number, locale?: SupportedLocales, useSI?: boolean, decimalPlaces?: number, trimInsignificantZeros?: boolean) => string;
 export declare const capitalizeStr: (str: string) => string | undefined;
 export declare const formatPercentage: (value: number, total: number) => string;
+export declare const roundPercentage: (val: number, roundDecimalCases?: number, locale?: SupportedLocales) => string;

package/es/formatters.js

@@ -135,9 +135,9 @@ export const formatCurrency = (value = 0, options = {
  * @return {String}
  */
 
-export const formatBytes = (number, locale = DEFAULT_LOCALE, includeDecimals) => {
+export const formatBytes = (number, locale = DEFAULT_LOCALE, includeDecimals, useBytes = false) => {
   return formatNumber(number, locale, 'si', includeDecimals ? 2 : 0) // Add space between value and SI unit
-  .replace(/([a-zA-Z]?)$/, ' $1') + 'B';
+  .replace(/([a-zA-Z]?)$/, ' $1') + `${useBytes ? 'Bytes' : 'B'}`;
 };
 /**
  * @param {Number} number
@@ -164,4 +164,26 @@ export const formatNumberForAnalytics = (number, locale = DEFAULT_LOCALE, useSI
   return formatNumber(number, locale, useSI, decimalPlaces, trimInsignificantZeros);
 };
 export const capitalizeStr = str => str && str.charAt(0).toUpperCase() + str.slice(1);
-export const formatPercentage = (value, total) => `${Math.round(value * 100 / total * 100) / 100}%`;
+export const formatPercentage = (value, total) => `${Math.round(value * 100 / total * 100) / 100}%`;
+export const roundPercentage = (val, roundDecimalCases = 0, locale = DEFAULT_LOCALE) => {
+  const roundDiv = Math.pow(10, roundDecimalCases); // Treat ~0% and ~100% values specially so the precision is surfaced
+
+  let localizedString = '';
+
+  if (val > 99) {
+    // Edge case: between 99 and 100, produce values with precision like this:
+    // 99.999735 --> 99.9997
+    localizedString = localizeNumberWithPrecision(100 - +(100 - val).toPrecision(1), locale);
+  } else if (val < 1) {
+    // Edge case: between 0 and 1, produce values with the precision of one
+    // significant digit:
+    // 0.000273 --> 0.0003
+    localizedString = localizeNumberWithPrecision(+val.toPrecision(1), locale);
+  } else {
+    // In all other cases, round to the nearest integer:
+    // 78.612 --> 79
+    localizedString = formatNumberForAnalytics(val * roundDiv / roundDiv, locale, false, roundDecimalCases);
+  }
+
+  return localizedString + '%';
+};

package/lib/formatters.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.formatPercentage = exports.capitalizeStr = exports.formatNumberForAnalytics = exports.formatBits = exports.formatBytes = exports.formatCurrency = exports.formatNumber = exports.localizeNumberWithPrecision = exports.formatDate = exports.DateFormatters = void 0;
+exports.roundPercentage = exports.formatPercentage = exports.capitalizeStr = exports.formatNumberForAnalytics = exports.formatBits = exports.formatBytes = exports.formatCurrency = exports.formatNumber = exports.localizeNumberWithPrecision = exports.formatDate = exports.DateFormatters = void 0;
 
 var _d3Format = require("d3-format");
 
@@ -174,8 +174,9 @@ exports.formatCurrency = formatCurrency;
 var formatBytes = function formatBytes(number) {
   var locale = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_LOCALE;
   var includeDecimals = arguments.length > 2 ? arguments[2] : undefined;
+  var useBytes = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
   return formatNumber(number, locale, 'si', includeDecimals ? 2 : 0) // Add space between value and SI unit
-  .replace(/([a-zA-Z]?)$/, ' $1') + 'B';
+  .replace(/([a-zA-Z]?)$/, ' $1') + "".concat(useBytes ? 'Bytes' : 'B');
 };
 /**
  * @param {Number} number
@@ -227,4 +228,31 @@ var formatPercentage = function formatPercentage(value, total) {
   return "".concat(Math.round(value * 100 / total * 100) / 100, "%");
 };
 
-exports.formatPercentage = formatPercentage;
+exports.formatPercentage = formatPercentage;
+
+var roundPercentage = function roundPercentage(val) {
+  var roundDecimalCases = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
+  var locale = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : DEFAULT_LOCALE;
+  var roundDiv = Math.pow(10, roundDecimalCases); // Treat ~0% and ~100% values specially so the precision is surfaced
+
+  var localizedString = '';
+
+  if (val > 99) {
+    // Edge case: between 99 and 100, produce values with precision like this:
+    // 99.999735 --> 99.9997
+    localizedString = localizeNumberWithPrecision(100 - +(100 - val).toPrecision(1), locale);
+  } else if (val < 1) {
+    // Edge case: between 0 and 1, produce values with the precision of one
+    // significant digit:
+    // 0.000273 --> 0.0003
+    localizedString = localizeNumberWithPrecision(+val.toPrecision(1), locale);
+  } else {
+    // In all other cases, round to the nearest integer:
+    // 78.612 --> 79
+    localizedString = formatNumberForAnalytics(val * roundDiv / roundDiv, locale, false, roundDecimalCases);
+  }
+
+  return localizedString + '%';
+};
+
+exports.roundPercentage = roundPercentage;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudflare/util-formatters",
   "description": "",
-  "version": "2.7.0",
+  "version": "2.7.3",
   "types": "./dist/index.d.ts",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -17,9 +17,9 @@
     "autoGeneratedReadme": true
   },
   "dependencies": {
-    "@cloudflare/intl-core": "^1.10.3",
+    "@cloudflare/intl-core": "^1.10.4",
     "d3-format": "^1.3.2",
-    "moment": "^2.22.1"
+    "moment": "^2.29.1"
   },
-  "gitHead": "46e16cc7018fe9cf0cde631e409f4d06b4441af7"
+  "gitHead": "16064397a5d5f2cf70fbbb5ced5c176604397439"
 }