@akadenia/helpers 1.8.0 → 1.9.0

package/README.MD

@@ -933,6 +933,26 @@ console.log(FileHelpers.checkFileExtension("script.js", ["js", "ts", "jsx"])) //
 console.log(FileHelpers.checkFileExtension("file", ["txt", "md"])) // false (no extension)
 ```
 
+### `formatFileSize(bytes)`
+
+Formats a file size in bytes to a human-readable string with appropriate units.
+
+**Parameters:**
+
+- `bytes`: `number | null` - The file size in bytes.
+
+**Example:**
+
+```typescript
+console.log(FileHelpers.formatFileSize(1024)) // "1.0 KB"
+console.log(FileHelpers.formatFileSize(1024 * 1024)) // "1.0 MB"
+console.log(FileHelpers.formatFileSize(1024 * 1024 * 1024)) // "1.0 GB"
+console.log(FileHelpers.formatFileSize(512)) // "512 B"
+console.log(FileHelpers.formatFileSize(1536)) // "1.5 KB"
+console.log(FileHelpers.formatFileSize(0)) // "0 B"
+console.log(FileHelpers.formatFileSize(null)) // "0 B"
+```
+
 ## Contributing
 
 We welcome contributions! Please feel free to submit a Pull Request.

package/dist/file.d.ts

@@ -8,3 +8,12 @@
  * checkFileExtension("test.txt", ["md"]) // false
  */
 export declare const checkFileExtension: (filePath: string, validExtensions: string[]) => boolean;
+/**
+ * Format a file size to a human readable string
+ * @param bytes The file size in bytes
+ * @returns The formatted file size
+ * @example
+ * formatFileSize(1024) // "1.0 KB"
+ * formatFileSize(1024 * 1024) // "1.0 MB"
+ */
+export declare const formatFileSize: (bytes: number | null) => string;

package/dist/file.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkFileExtension = void 0;
+exports.formatFileSize = exports.checkFileExtension = void 0;
 /**
  * Check if a file path has a valid extension
  * @param filePath The file path to check
@@ -15,3 +15,21 @@ const checkFileExtension = (filePath, validExtensions) => {
     return !!fileExtension && validExtensions.includes(fileExtension);
 };
 exports.checkFileExtension = checkFileExtension;
+/**
+ * Format a file size to a human readable string
+ * @param bytes The file size in bytes
+ * @returns The formatted file size
+ * @example
+ * formatFileSize(1024) // "1.0 KB"
+ * formatFileSize(1024 * 1024) // "1.0 MB"
+ */
+const formatFileSize = (bytes) => {
+    if (!bytes || bytes <= 0)
+        return "0 B";
+    const units = ["B", "KB", "MB", "GB", "TB"];
+    const unitIndex = Math.floor(Math.log2(bytes) / 10);
+    const clampedIndex = Math.min(unitIndex, units.length - 1);
+    const size = bytes / Math.pow(1024, clampedIndex);
+    return `${size.toFixed(clampedIndex === 0 ? 0 : 1)} ${units[clampedIndex]}`;
+};
+exports.formatFileSize = formatFileSize;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akadenia/helpers",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Akadenia helpers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,7 @@
     "akadenia"
   ],
   "scripts": {
-    "build": "rm -rf dist && tsc -p tsconfig.json",
+    "build": "rimraf dist && tsc -p tsconfig.json",
     "test": "jest",
     "format": "prettier --write \"./**/*.{ts,tsx,js,jsx,json,yml}\"",
     "lint": "prettier --check \"./**/*.{ts,tsx,js,jsx,json,yml}\"",
@@ -42,6 +42,7 @@
     "jest": "^29.7.0",
     "jsdoc-to-markdown": "^8.0.3",
     "prettier": "^3.3.3",
+    "rimraf": "^6.0.1",
     "semantic-release": "22.0.12",
     "ts-jest": "^29.2.5",
     "typescript": "^5.6.2"