@akadenia/helpers 1.6.0 → 1.7.0

package/README.MD

@@ -347,14 +347,21 @@ Arguments
 
 ## `TextHelpers.abbreviateNumber(number)`
 
-Abbreviate number
-Returns the string representation of the abbreviated number
+Returns the string representation of the abbreviated number, rounded to two decimal places.
 
 Arguments
 |Name|Type|Required|Description|
 |--|--|--|--|
 |`number`|`number`|`true`|The number to be abbreviated|
 
+Examples
+- Numbers below 1,000 are displayed without abbreviation
+- Numbers between 1,000 and 1,000,000 are displayed in thousands (e.g. 1.23K)
+- Numbers between 1,000,000 and 1,000,000,000 are displayed in millions (e.g. 1.23M)
+- Numbers above 1,000,000,000 are displayed in billions (e.g. 1.23B)
+
+Note: If the input `number` is null or undefined, the function returns null.
+
 # ObjectHelpers
 
 Import the ObjectHelpers utility.

package/dist/text.js

@@ -302,14 +302,14 @@ const abbreviateNumber = (number) => {
     const abbreviations = [
         { value: 1e9, symbol: "B" },
         { value: 1e6, symbol: "M" },
-        { value: 1e3, symbol: "k" },
+        { value: 1e3, symbol: "K" },
     ];
     if (!number || isNaN(number))
         return null;
     const abbreviated = abbreviations.find(({ value }) => Math.abs(number) >= value);
     if (abbreviated) {
         const { value, symbol } = abbreviated;
-        return (number / value).toFixed(1).replace(/\.0$/, "") + symbol;
+        return (number / value).toFixed(2).replace(/\.00$/, "") + symbol;
     }
     return number.toString();
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akadenia/helpers",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Akadenia helpers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",