tiny-essentials 1.8.2 → 1.8.3

package/dist/TinyBasicsEs.js

@@ -2203,8 +2203,8 @@ async function asyncReplace(str, regex, asyncFn) {
  * This implementation ensures a uniform distribution of permutations.
  * Original algorithm source: StackOverflow (link above).
  *
- * @param {string[]} items - The array to shuffle.
- * @returns {string[]} The same array instance, now shuffled in place.
+ * @param {any[]} items - The array to shuffle.
+ * @returns {any[]} The same array instance, now shuffled in place.
  */
 function shuffleArray(items) {
   let currentIndex = items.length,
@@ -2805,13 +2805,19 @@ function getAge(timeData = 0, now = null) {
   return null;
 }
 
+/**
+ * @typedef {Object} FormattedByteResult
+ * @property {string|null} unit - The resulting unit (e.g., 'MB', 'GB') or null if input is invalid.
+ * @property {number|null} value - The numerical value in the chosen unit, or null if input is invalid.
+ */
+
 /**
  * Converts a byte value into a human-readable format with unit and value separated.
  *
  * @param {number} bytes - The number of bytes to format. Must be a non-negative number.
  * @param {number|null} [decimals=null] - The number of decimal places to include in the result. Defaults to null. If negative, it will be treated as 0. If null, no rounding is applied.
  * @param {string|null} [maxUnit=null] - Optional unit limit. If provided, restricts conversion to this unit at most (e.g., 'MB' prevents conversion to 'GB' or higher). Must be one of: 'Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'.
- * @returns {{ unit: string|null, value: number|null }} An object with the converted value and its corresponding unit. Returns nulls if input is invalid.
+ * @returns {FormattedByteResult} An object with the converted value and its corresponding unit. Returns nulls if input is invalid.
  *
  * @example
  * formatBytes(123456789);

package/dist/TinyEssentials.js

@@ -2349,8 +2349,8 @@ class TinyLevelUp {
  * This implementation ensures a uniform distribution of permutations.
  * Original algorithm source: StackOverflow (link above).
  *
- * @param {string[]} items - The array to shuffle.
- * @returns {string[]} The same array instance, now shuffled in place.
+ * @param {any[]} items - The array to shuffle.
+ * @returns {any[]} The same array instance, now shuffled in place.
  */
 function shuffleArray(items) {
   let currentIndex = items.length,
@@ -2951,13 +2951,19 @@ function getAge(timeData = 0, now = null) {
   return null;
 }
 
+/**
+ * @typedef {Object} FormattedByteResult
+ * @property {string|null} unit - The resulting unit (e.g., 'MB', 'GB') or null if input is invalid.
+ * @property {number|null} value - The numerical value in the chosen unit, or null if input is invalid.
+ */
+
 /**
  * Converts a byte value into a human-readable format with unit and value separated.
  *
  * @param {number} bytes - The number of bytes to format. Must be a non-negative number.
  * @param {number|null} [decimals=null] - The number of decimal places to include in the result. Defaults to null. If negative, it will be treated as 0. If null, no rounding is applied.
  * @param {string|null} [maxUnit=null] - Optional unit limit. If provided, restricts conversion to this unit at most (e.g., 'MB' prevents conversion to 'GB' or higher). Must be one of: 'Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'.
- * @returns {{ unit: string|null, value: number|null }} An object with the converted value and its corresponding unit. Returns nulls if input is invalid.
+ * @returns {FormattedByteResult} An object with the converted value and its corresponding unit. Returns nulls if input is invalid.
  *
  * @example
  * formatBytes(123456789);

package/dist/v1/basics/array.cjs

@@ -8,8 +8,8 @@
  * This implementation ensures a uniform distribution of permutations.
  * Original algorithm source: StackOverflow (link above).
  *
- * @param {string[]} items - The array to shuffle.
- * @returns {string[]} The same array instance, now shuffled in place.
+ * @param {any[]} items - The array to shuffle.
+ * @returns {any[]} The same array instance, now shuffled in place.
  */
 function shuffleArray(items) {
   let currentIndex = items.length,

package/dist/v1/basics/array.d.mts

@@ -4,8 +4,8 @@
  * This implementation ensures a uniform distribution of permutations.
  * Original algorithm source: StackOverflow (link above).
  *
- * @param {string[]} items - The array to shuffle.
- * @returns {string[]} The same array instance, now shuffled in place.
+ * @param {any[]} items - The array to shuffle.
+ * @returns {any[]} The same array instance, now shuffled in place.
  */
-export function shuffleArray(items: string[]): string[];
+export function shuffleArray(items: any[]): any[];
 //# sourceMappingURL=array.d.mts.map

package/dist/v1/basics/array.mjs

@@ -5,8 +5,8 @@
  * This implementation ensures a uniform distribution of permutations.
  * Original algorithm source: StackOverflow (link above).
  *
- * @param {string[]} items - The array to shuffle.
- * @returns {string[]} The same array instance, now shuffled in place.
+ * @param {any[]} items - The array to shuffle.
+ * @returns {any[]} The same array instance, now shuffled in place.
  */
 export function shuffleArray(items) {
     let currentIndex = items.length, randomIndex;

package/dist/v1/basics/simpleMath.cjs

@@ -83,13 +83,19 @@ function getAge(timeData = 0, now = null) {
   return null;
 }
 
+/**
+ * @typedef {Object} FormattedByteResult
+ * @property {string|null} unit - The resulting unit (e.g., 'MB', 'GB') or null if input is invalid.
+ * @property {number|null} value - The numerical value in the chosen unit, or null if input is invalid.
+ */
+
 /**
  * Converts a byte value into a human-readable format with unit and value separated.
  *
  * @param {number} bytes - The number of bytes to format. Must be a non-negative number.
  * @param {number|null} [decimals=null] - The number of decimal places to include in the result. Defaults to null. If negative, it will be treated as 0. If null, no rounding is applied.
  * @param {string|null} [maxUnit=null] - Optional unit limit. If provided, restricts conversion to this unit at most (e.g., 'MB' prevents conversion to 'GB' or higher). Must be one of: 'Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'.
- * @returns {{ unit: string|null, value: number|null }} An object with the converted value and its corresponding unit. Returns nulls if input is invalid.
+ * @returns {FormattedByteResult} An object with the converted value and its corresponding unit. Returns nulls if input is invalid.
  *
  * @example
  * formatBytes(123456789);

package/dist/v1/basics/simpleMath.d.mts

@@ -52,13 +52,18 @@ export function getSimplePerc(price: number, percentage: number): number;
  * @returns {number|null} The age in years, or null if `timeData` is not provided or invalid.
  */
 export function getAge(timeData?: number | string | Date, now?: Date | null): number | null;
+/**
+ * @typedef {Object} FormattedByteResult
+ * @property {string|null} unit - The resulting unit (e.g., 'MB', 'GB') or null if input is invalid.
+ * @property {number|null} value - The numerical value in the chosen unit, or null if input is invalid.
+ */
 /**
  * Converts a byte value into a human-readable format with unit and value separated.
  *
  * @param {number} bytes - The number of bytes to format. Must be a non-negative number.
  * @param {number|null} [decimals=null] - The number of decimal places to include in the result. Defaults to null. If negative, it will be treated as 0. If null, no rounding is applied.
  * @param {string|null} [maxUnit=null] - Optional unit limit. If provided, restricts conversion to this unit at most (e.g., 'MB' prevents conversion to 'GB' or higher). Must be one of: 'Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'.
- * @returns {{ unit: string|null, value: number|null }} An object with the converted value and its corresponding unit. Returns nulls if input is invalid.
+ * @returns {FormattedByteResult} An object with the converted value and its corresponding unit. Returns nulls if input is invalid.
  *
  * @example
  * formatBytes(123456789);
@@ -68,8 +73,15 @@ export function getAge(timeData?: number | string | Date, now?: Date | null): nu
  * formatBytes(1073741824, 2, 'MB');
  * // → { unit: 'MB', value: 1024 }
  */
-export function formatBytes(bytes: number, decimals?: number | null, maxUnit?: string | null): {
+export function formatBytes(bytes: number, decimals?: number | null, maxUnit?: string | null): FormattedByteResult;
+export type FormattedByteResult = {
+    /**
+     * - The resulting unit (e.g., 'MB', 'GB') or null if input is invalid.
+     */
     unit: string | null;
+    /**
+     * - The numerical value in the chosen unit, or null if input is invalid.
+     */
     value: number | null;
 };
 //# sourceMappingURL=simpleMath.d.mts.map

package/dist/v1/basics/simpleMath.mjs

@@ -73,13 +73,18 @@ export function getAge(timeData = 0, now = null) {
     }
     return null;
 }
+/**
+ * @typedef {Object} FormattedByteResult
+ * @property {string|null} unit - The resulting unit (e.g., 'MB', 'GB') or null if input is invalid.
+ * @property {number|null} value - The numerical value in the chosen unit, or null if input is invalid.
+ */
 /**
  * Converts a byte value into a human-readable format with unit and value separated.
  *
  * @param {number} bytes - The number of bytes to format. Must be a non-negative number.
  * @param {number|null} [decimals=null] - The number of decimal places to include in the result. Defaults to null. If negative, it will be treated as 0. If null, no rounding is applied.
  * @param {string|null} [maxUnit=null] - Optional unit limit. If provided, restricts conversion to this unit at most (e.g., 'MB' prevents conversion to 'GB' or higher). Must be one of: 'Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'.
- * @returns {{ unit: string|null, value: number|null }} An object with the converted value and its corresponding unit. Returns nulls if input is invalid.
+ * @returns {FormattedByteResult} An object with the converted value and its corresponding unit. Returns nulls if input is invalid.
  *
  * @example
  * formatBytes(123456789);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-essentials",
-  "version": "1.8.2",
+  "version": "1.8.3",
   "description": "Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.",
   "scripts": {
     "test": "npm run test:mjs && npm run test:cjs && npm run test:js",