Added byteValueToHumanString

Author: luca-vogels

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lup-utils",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "NodeJS library providing utility functions.",
   "main": "./lib/index",
   "types": "./lib/index.d.ts",

src/string.ts

@@ -1,3 +1,37 @@
+/**
+ * Converts a byte value to a human-readable string.
+ * 
+ * @param bytes Value in bytes to convert to a human-readable string.
+ * @param options Options for converting the string.
+ * @returns Human-readable string representation of the byte value (e.g. )
+ */
+export function byteValueToHumanString(bytes: number, options?: {
+
+  /** Whether to use the decimal (base 1000) or the binary (base 1024) for conversion (default 1024). */
+  decimalBase?: boolean;
+
+  /** If the label should be binary (e.g. "GiB" vs "GB") if decimalBase is false (default false). */
+  binaryLabel?: boolean;
+
+  /** Number of decimal places to include (default 0). */
+  precision?: number;
+
+}): string {
+  const units = (!options?.decimalBase && options?.binaryLabel)
+      ? ['B', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB']
+      : ['B', 'KB', 'MB', 'GB', 'TB', 'PB'];
+  const step = options?.decimalBase ? 1000 : 1024;
+  let i = 0;
+  let humanReadable = bytes;
+
+  while (humanReadable >= step && i < units.length - 1) {
+    humanReadable /= step;
+    i++;
+  }
+
+  return humanReadable.toFixed(options?.precision ?? 0)+' '+units[i];
+}
+
 /**
  * Parses a byte value from a string.
  *