@helpers4/number 2.0.0-alpha.18 → 2.0.0-alpha.19

package/README.md

@@ -13,6 +13,7 @@ A set of helpers for working with URLs.
 
 <!-- AUTOMATIC-METHODS -->
 - clamp
+- formatSize
 - random
 - roundTo
 - sum

package/lib/index.d.ts

@@ -13,6 +13,30 @@
  */
 declare function clamp(value: number, min: number, max: number): number;
 
+/**
+ * This file is part of helpers4.
+ * Copyright (C) 2025 baxyz
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+/**
+ * Format a byte count into a human-readable string with the appropriate unit.
+ *
+ * Each unit is 1024 of the previous (binary prefix). The result is formatted
+ * with one decimal place.
+ *
+ * @param bytes - A non-negative integer representing a byte count.
+ * @returns A human-readable string such as `'0.0B'`, `'1.5KB'`, `'3.2MB'`.
+ * @example
+ * formatSize(0)               // '0.0B'
+ * formatSize(512)             // '512.0B'
+ * formatSize(1024)            // '1.0KB'
+ * formatSize(1536)            // '1.5KB'
+ * formatSize(1_048_576)       // '1.0MB'
+ * formatSize(1_073_741_824)   // '1.0GB'
+ * @since next
+ */
+declare function formatSize(bytes: number): string;
+
 /**
  * This file is part of helpers4.
  * Copyright (C) 2025 baxyz
@@ -65,4 +89,4 @@ declare function roundTo(value: number, decimals: number): number;
  */
 declare function sum(array: readonly number[]): number;
 
-export { clamp, randomBetween, randomIntBetween, roundTo, sum };
+export { clamp, formatSize, randomBetween, randomIntBetween, roundTo, sum };

package/lib/index.js

@@ -16,6 +16,47 @@ function clamp(value, min, max) {
 	return Math.min(Math.max(value, min), max);
 }
 //#endregion
+//#region helpers/number/formatSize.ts
+/**
+* This file is part of helpers4.
+* Copyright (C) 2025 baxyz
+* SPDX-License-Identifier: LGPL-3.0-or-later
+*/
+/** Size units in ascending order. */
+var UNITS = [
+	"B",
+	"KB",
+	"MB",
+	"GB",
+	"TB"
+];
+/**
+* Format a byte count into a human-readable string with the appropriate unit.
+*
+* Each unit is 1024 of the previous (binary prefix). The result is formatted
+* with one decimal place.
+*
+* @param bytes - A non-negative integer representing a byte count.
+* @returns A human-readable string such as `'0.0B'`, `'1.5KB'`, `'3.2MB'`.
+* @example
+* formatSize(0)               // '0.0B'
+* formatSize(512)             // '512.0B'
+* formatSize(1024)            // '1.0KB'
+* formatSize(1536)            // '1.5KB'
+* formatSize(1_048_576)       // '1.0MB'
+* formatSize(1_073_741_824)   // '1.0GB'
+* @since next
+*/
+function formatSize(bytes) {
+	let size = bytes;
+	let unitIndex = 0;
+	while (size >= 1024 && unitIndex < UNITS.length - 1) {
+		size /= 1024;
+		unitIndex++;
+	}
+	return `${size.toFixed(1)}${UNITS[unitIndex]}`;
+}
+//#endregion
 //#region helpers/number/random.ts
 /**
 * This file is part of helpers4.
@@ -80,6 +121,6 @@ function sum(array) {
 	return array.reduce((acc, n) => acc + n, 0);
 }
 //#endregion
-export { clamp, randomBetween, randomIntBetween, roundTo, sum };
+export { clamp, formatSize, randomBetween, randomIntBetween, roundTo, sum };
 
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../../helpers/number/clamp.ts","../../../helpers/number/random.ts","../../../helpers/number/roundTo.ts","../../../helpers/number/sum.ts"],"sourcesContent":["/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Clamps a number between min and max values\n * @param value - The value to clamp\n * @param min - Minimum value\n * @param max - Maximum value\n * @returns Clamped value\n * @since 1.9.0\n */\nexport function clamp(value: number, min: number, max: number): number {\n  return Math.min(Math.max(value, min), max);\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Generates a random number between min and max (inclusive)\n * @param min - Minimum value\n * @param max - Maximum value\n * @returns Random number between min and max\n * @since 1.9.0\n */\nexport function randomBetween(min: number, max: number): number {\n  return Math.random() * (max - min) + min;\n}\n\n/**\n * Generates a random integer between min and max (inclusive)\n * @param min - Minimum value\n * @param max - Maximum value\n * @returns Random integer between min and max\n * @since 1.9.0\n */\nexport function randomIntBetween(min: number, max: number): number {\n  return Math.floor(Math.random() * (max - min + 1)) + min;\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Rounds a number to specified decimal places\n * @param value - The number to round\n * @param decimals - Number of decimal places\n * @returns Rounded number\n * @since 1.9.0\n */\nexport function roundTo(value: number, decimals: number): number {\n  const multiplier = Math.pow(10, decimals);\n  return Math.round(value * multiplier) / multiplier;\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Calculates the sum of an array of numbers.\n * @param array - The array of numbers to sum\n * @returns The sum of all values\n * @example\n * sum([1, 2, 3, 4])\n * // => 10\n * @since 2.0.0\n */\nexport function sum(array: readonly number[]): number {\n  return array.reduce((acc, n) => acc + n, 0);\n}\n"],"mappings":";;;;;;;;;;;;;;AAcA,SAAgB,MAAM,OAAe,KAAa,KAAqB;AACrE,QAAO,KAAK,IAAI,KAAK,IAAI,OAAO,IAAI,EAAE,IAAI;;;;;;;;;;;;;;;;ACF5C,SAAgB,cAAc,KAAa,KAAqB;AAC9D,QAAO,KAAK,QAAQ,IAAI,MAAM,OAAO;;;;;;;;;AAUvC,SAAgB,iBAAiB,KAAa,KAAqB;AACjE,QAAO,KAAK,MAAM,KAAK,QAAQ,IAAI,MAAM,MAAM,GAAG,GAAG;;;;;;;;;;;;;;;;ACZvD,SAAgB,QAAQ,OAAe,UAA0B;CAC/D,MAAM,aAAa,KAAK,IAAI,IAAI,SAAS;AACzC,QAAO,KAAK,MAAM,QAAQ,WAAW,GAAG;;;;;;;;;;;;;;;;;;ACA1C,SAAgB,IAAI,OAAkC;AACpD,QAAO,MAAM,QAAQ,KAAK,MAAM,MAAM,GAAG,EAAE"}
+{"version":3,"file":"index.js","names":[],"sources":["../../../helpers/number/clamp.ts","../../../helpers/number/formatSize.ts","../../../helpers/number/random.ts","../../../helpers/number/roundTo.ts","../../../helpers/number/sum.ts"],"sourcesContent":["/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Clamps a number between min and max values\n * @param value - The value to clamp\n * @param min - Minimum value\n * @param max - Maximum value\n * @returns Clamped value\n * @since 1.9.0\n */\nexport function clamp(value: number, min: number, max: number): number {\n  return Math.min(Math.max(value, min), max);\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/** Size units in ascending order. */\nconst UNITS = ['B', 'KB', 'MB', 'GB', 'TB'] as const;\n\n/**\n * Format a byte count into a human-readable string with the appropriate unit.\n *\n * Each unit is 1024 of the previous (binary prefix). The result is formatted\n * with one decimal place.\n *\n * @param bytes - A non-negative integer representing a byte count.\n * @returns A human-readable string such as `'0.0B'`, `'1.5KB'`, `'3.2MB'`.\n * @example\n * formatSize(0)               // '0.0B'\n * formatSize(512)             // '512.0B'\n * formatSize(1024)            // '1.0KB'\n * formatSize(1536)            // '1.5KB'\n * formatSize(1_048_576)       // '1.0MB'\n * formatSize(1_073_741_824)   // '1.0GB'\n * @since next\n */\nexport function formatSize(bytes: number): string {\n  let size = bytes;\n  let unitIndex = 0;\n\n  while (size >= 1024 && unitIndex < UNITS.length - 1) {\n    size /= 1024;\n    unitIndex++;\n  }\n\n  return `${size.toFixed(1)}${UNITS[unitIndex]}`;\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Generates a random number between min and max (inclusive)\n * @param min - Minimum value\n * @param max - Maximum value\n * @returns Random number between min and max\n * @since 1.9.0\n */\nexport function randomBetween(min: number, max: number): number {\n  return Math.random() * (max - min) + min;\n}\n\n/**\n * Generates a random integer between min and max (inclusive)\n * @param min - Minimum value\n * @param max - Maximum value\n * @returns Random integer between min and max\n * @since 1.9.0\n */\nexport function randomIntBetween(min: number, max: number): number {\n  return Math.floor(Math.random() * (max - min + 1)) + min;\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Rounds a number to specified decimal places\n * @param value - The number to round\n * @param decimals - Number of decimal places\n * @returns Rounded number\n * @since 1.9.0\n */\nexport function roundTo(value: number, decimals: number): number {\n  const multiplier = Math.pow(10, decimals);\n  return Math.round(value * multiplier) / multiplier;\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Calculates the sum of an array of numbers.\n * @param array - The array of numbers to sum\n * @returns The sum of all values\n * @example\n * sum([1, 2, 3, 4])\n * // => 10\n * @since 2.0.0\n */\nexport function sum(array: readonly number[]): number {\n  return array.reduce((acc, n) => acc + n, 0);\n}\n"],"mappings":";;;;;;;;;;;;;;AAcA,SAAgB,MAAM,OAAe,KAAa,KAAqB;AACrE,QAAO,KAAK,IAAI,KAAK,IAAI,OAAO,IAAI,EAAE,IAAI;;;;;;;;;;ACR5C,IAAM,QAAQ;CAAC;CAAK;CAAM;CAAM;CAAM;CAAK;;;;;;;;;;;;;;;;;;AAmB3C,SAAgB,WAAW,OAAuB;CAChD,IAAI,OAAO;CACX,IAAI,YAAY;AAEhB,QAAO,QAAQ,QAAQ,YAAY,MAAM,SAAS,GAAG;AACnD,UAAQ;AACR;;AAGF,QAAO,GAAG,KAAK,QAAQ,EAAE,GAAG,MAAM;;;;;;;;;;;;;;;;ACtBpC,SAAgB,cAAc,KAAa,KAAqB;AAC9D,QAAO,KAAK,QAAQ,IAAI,MAAM,OAAO;;;;;;;;;AAUvC,SAAgB,iBAAiB,KAAa,KAAqB;AACjE,QAAO,KAAK,MAAM,KAAK,QAAQ,IAAI,MAAM,MAAM,GAAG,GAAG;;;;;;;;;;;;;;;;ACZvD,SAAgB,QAAQ,OAAe,UAA0B;CAC/D,MAAM,aAAa,KAAK,IAAI,IAAI,SAAS;AACzC,QAAO,KAAK,MAAM,QAAQ,WAAW,GAAG;;;;;;;;;;;;;;;;;;ACA1C,SAAgB,IAAI,OAAkC;AACpD,QAAO,MAAM,QAAQ,KAAK,MAAM,MAAM,GAAG,EAAE"}

package/llms.txt

@@ -1,7 +1,7 @@
 # @helpers4/number
 
 > Tree-shakable TypeScript utility functions for the `number` domain.
-> Package: `@helpers4/number` — Version: 2.0.0-alpha.18
+> Package: `@helpers4/number` — Version: 2.0.0-alpha.19
 > License: LGPL-3.0-or-later
 
 ## Installation
@@ -15,7 +15,7 @@ pnpm add @helpers4/number
 ## Usage
 
 ```typescript
-import { clamp, randomBetween, randomIntBetween, ... } from '@helpers4/number';
+import { clamp, formatSize, randomBetween, ... } from '@helpers4/number';
 ```
 
 ## Functions
@@ -23,6 +23,7 @@ import { clamp, randomBetween, randomIntBetween, ... } from '@helpers4/number';
 | Function | Description |
 |---|---|
 | `clamp` | Clamps a number between min and max values |
+| `formatSize` | Format a byte count into a human-readable string with the appropriate unit.  Each unit is 1024 of th |
 | `randomBetween` | Generates a random number between min and max (inclusive) |
 | `randomIntBetween` | Generates a random integer between min and max (inclusive) |
 | `roundTo` | Rounds a number to specified decimal places |
@@ -64,6 +65,41 @@ clamp(5, 0, 10)   // => 5
 
 ---
 
+### `formatSize`
+
+Format a byte count into a human-readable string with the appropriate unit.
+
+Each unit is 1024 of the previous (binary prefix). The result is formatted
+with one decimal place.
+
+```typescript
+import { formatSize } from '@helpers4/number';
+
+formatSize(bytes: number): string
+```
+
+**Parameters:**
+
+- `bytes: number` — A non-negative integer representing a byte count.
+
+**Returns:** `string` — A human-readable string such as `'0.0B'`, `'1.5KB'`, `'3.2MB'`.
+
+**Examples:**
+
+*Format bytes to human-readable size*
+
+Converts a raw byte count to a human-readable string using binary prefixes.
+
+```typescript
+formatSize(0)             // '0.0B'
+formatSize(512)           // '512.0B'
+formatSize(1024)          // '1.0KB'
+formatSize(1_048_576)     // '1.0MB'
+formatSize(1_073_741_824) // '1.0GB'
+```
+
+---
+
 ### `randomBetween`
 
 Generates a random number between min and max (inclusive)

package/meta/api.json

@@ -1,6 +1,6 @@
 {
   "category": "number",
-  "version": "2.0.0-alpha.18",
+  "version": "2.0.0-alpha.19",
   "functions": [
     {
       "name": "clamp",
@@ -43,6 +43,37 @@
       ],
       "sourceFile": "clamp.ts"
     },
+    {
+      "name": "formatSize",
+      "kind": "function",
+      "description": "Format a byte count into a human-readable string with the appropriate unit.\n\nEach unit is 1024 of the previous (binary prefix). The result is formatted\nwith one decimal place.",
+      "since": "next",
+      "signatures": [
+        {
+          "signature": "formatSize(bytes: number): string",
+          "description": "Format a byte count into a human-readable string with the appropriate unit.\n\nEach unit is 1024 of the previous (binary prefix). The result is formatted\nwith one decimal place.",
+          "params": [
+            {
+              "name": "bytes",
+              "type": "number",
+              "description": "A non-negative integer representing a byte count."
+            }
+          ],
+          "returns": {
+            "type": "string",
+            "description": "A human-readable string such as `'0.0B'`, `'1.5KB'`, `'3.2MB'`."
+          }
+        }
+      ],
+      "examples": [
+        {
+          "title": "Format bytes to human-readable size",
+          "description": "Converts a raw byte count to a human-readable string using binary prefixes.",
+          "code": "formatSize(0)             // '0.0B'\nformatSize(512)           // '512.0B'\nformatSize(1024)          // '1.0KB'\nformatSize(1_048_576)     // '1.0MB'\nformatSize(1_073_741_824) // '1.0GB'"
+        }
+      ],
+      "sourceFile": "formatSize.ts"
+    },
     {
       "name": "randomBetween",
       "kind": "function",

package/meta/examples.json

@@ -11,6 +11,16 @@
         }
       ]
     },
+    {
+      "name": "formatSize",
+      "examples": [
+        {
+          "title": "Format bytes to human-readable size",
+          "description": "Converts a raw byte count to a human-readable string using binary prefixes.",
+          "code": "formatSize(0)             // '0.0B'\nformatSize(512)           // '512.0B'\nformatSize(1024)          // '1.0KB'\nformatSize(1_048_576)     // '1.0MB'\nformatSize(1_073_741_824) // '1.0GB'"
+        }
+      ]
+    },
     {
       "name": "randomBetween",
       "examples": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helpers4/number",
-  "version": "2.0.0-alpha.18",
+  "version": "2.0.0-alpha.19",
   "description": "A set of helpers in TS/JS, compatible with tree-shaking, for number.",
   "author": "baxyz <baxy@etik.com>",
   "license": "LGPL-3.0",
@@ -28,6 +28,7 @@
     "helpers",
     "number",
     "clamp",
+    "formatSize",
     "random",
     "roundTo",
     "sum"