es-toolkit 1.5.0 → 1.6.0-dev.113

package/dist/index.mjs

@@ -1,8 +1,24 @@
+import "./chunk-MAJSPFA6.mjs";
+import {
+  isNil
+} from "./chunk-OHQAR5AU.mjs";
+import {
+  isNotNil
+} from "./chunk-ZQNAZPSK.mjs";
+import {
+  isNull
+} from "./chunk-AIRSKN47.mjs";
+import {
+  isUndefined
+} from "./chunk-VH2PV426.mjs";
 import "./chunk-ARZ5BDR6.mjs";
 import {
   delay
 } from "./chunk-AL3GJBEI.mjs";
 import "./chunk-T5JCRGXA.mjs";
+import {
+  pickBy
+} from "./chunk-MQWVBKUT.mjs";
 import {
   omit
 } from "./chunk-PLTO44KM.mjs";
@@ -12,48 +28,42 @@ import {
 import {
   pick
 } from "./chunk-OFWKFUFZ.mjs";
+import "./chunk-N6EM6ETS.mjs";
 import {
-  pickBy
-} from "./chunk-MQWVBKUT.mjs";
-import "./chunk-MAJSPFA6.mjs";
-import {
-  isNull
-} from "./chunk-AIRSKN47.mjs";
-import {
-  isUndefined
-} from "./chunk-VH2PV426.mjs";
-import {
-  isNil
-} from "./chunk-OHQAR5AU.mjs";
+  noop
+} from "./chunk-LKXCOLNY.mjs";
 import {
-  isNotNil
-} from "./chunk-ZQNAZPSK.mjs";
-import "./chunk-7LAMAYGN.mjs";
+  once
+} from "./chunk-UFAA5WKR.mjs";
 import {
-  clamp
-} from "./chunk-MLCL773E.mjs";
+  throttle
+} from "./chunk-XLO3QZVY.mjs";
+import "./chunk-QVHWSUEH.mjs";
 import {
   randomInt
-} from "./chunk-5UT77WON.mjs";
-import {
-  random
-} from "./chunk-LCP6FOCX.mjs";
+} from "./chunk-WC5HFQXP.mjs";
 import {
   range
 } from "./chunk-UNLX2F2Y.mjs";
 import {
   round
 } from "./chunk-5PMKOZ2F.mjs";
+import {
+  clamp
+} from "./chunk-MLCL773E.mjs";
+import {
+  mean
+} from "./chunk-S3GNYAM2.mjs";
 import {
   sum
-} from "./chunk-7OU22ENP.mjs";
-import "./chunk-NP6PDX3E.mjs";
+} from "./chunk-NOFHNJ5C.mjs";
 import {
-  zipWith
-} from "./chunk-4KYXHZ4R.mjs";
+  random
+} from "./chunk-SYWMYQYJ.mjs";
 import {
-  uniqBy
-} from "./chunk-WPDDOUQT.mjs";
+  debounce
+} from "./chunk-MKETZ2RP.mjs";
+import "./chunk-V6MDTRGS.mjs";
 import {
   xor
 } from "./chunk-G2TTBLLJ.mjs";
@@ -63,24 +73,15 @@ import {
 import {
   xorWith
 } from "./chunk-UMDNWTJC.mjs";
-import {
-  unionWith
-} from "./chunk-642SWVKJ.mjs";
-import {
-  uniqWith
-} from "./chunk-2PFDLYQC.mjs";
 import {
   zip
 } from "./chunk-IDCUZVJL.mjs";
 import {
-  sample
-} from "./chunk-DOOIIHT3.mjs";
-import {
-  shuffle
-} from "./chunk-DPLJQQFX.mjs";
+  zipObject
+} from "./chunk-DA7GSKQ5.mjs";
 import {
-  take
-} from "./chunk-ME352XO7.mjs";
+  zipWith
+} from "./chunk-4KYXHZ4R.mjs";
 import {
   takeRight
 } from "./chunk-XDKEPIUV.mjs";
@@ -93,45 +94,45 @@ import {
 import {
   union
 } from "./chunk-DAJZ3JCI.mjs";
-import {
-  uniq
-} from "./chunk-XFCW7XJ4.mjs";
 import {
   unionBy
 } from "./chunk-NRNKP6JF.mjs";
 import {
-  groupBy
-} from "./chunk-LWXZFXY5.mjs";
+  unionWith
+} from "./chunk-642SWVKJ.mjs";
 import {
-  intersection
-} from "./chunk-PYLGHB3F.mjs";
+  uniqWith
+} from "./chunk-2PFDLYQC.mjs";
 import {
-  intersectionBy
-} from "./chunk-GNSJP2AB.mjs";
+  uniq
+} from "./chunk-XFCW7XJ4.mjs";
+import {
+  uniqBy
+} from "./chunk-WPDDOUQT.mjs";
 import {
   intersectionWith
 } from "./chunk-2EFS3VA3.mjs";
+import {
+  keyBy
+} from "./chunk-ZOTAORG3.mjs";
 import {
   maxBy
-} from "./chunk-KZ5JY7J3.mjs";
+} from "./chunk-FXOABQRO.mjs";
 import {
   minBy
-} from "./chunk-H23GUJVF.mjs";
+} from "./chunk-OIHARMNM.mjs";
 import {
   partition
 } from "./chunk-5L2V7WD3.mjs";
 import {
-  chunk
-} from "./chunk-E6C5EZQA.mjs";
-import {
-  difference
-} from "./chunk-JPUKH67K.mjs";
+  sample
+} from "./chunk-DOOIIHT3.mjs";
 import {
-  differenceBy
-} from "./chunk-LVWX5B43.mjs";
+  shuffle
+} from "./chunk-DPLJQQFX.mjs";
 import {
-  differenceWith
-} from "./chunk-6NVQAHXP.mjs";
+  take
+} from "./chunk-ME352XO7.mjs";
 import {
   drop
 } from "./chunk-ACFP3XMB.mjs";
@@ -144,28 +145,40 @@ import {
 import {
   dropWhile
 } from "./chunk-K2BAFL2T.mjs";
+import {
+  groupBy
+} from "./chunk-LWXZFXY5.mjs";
+import {
+  intersection
+} from "./chunk-PYLGHB3F.mjs";
+import {
+  intersectionBy
+} from "./chunk-GNSJP2AB.mjs";
 import "./chunk-FZEZH22H.mjs";
 import {
   AbortError
 } from "./chunk-VP2LXY75.mjs";
-import "./chunk-N6EM6ETS.mjs";
 import {
-  debounce
-} from "./chunk-MKETZ2RP.mjs";
+  chunk
+} from "./chunk-E6C5EZQA.mjs";
 import {
-  noop
-} from "./chunk-LKXCOLNY.mjs";
+  compact
+} from "./chunk-NKTBEEIT.mjs";
 import {
-  once
-} from "./chunk-UFAA5WKR.mjs";
+  difference
+} from "./chunk-JPUKH67K.mjs";
 import {
-  throttle
-} from "./chunk-XLO3QZVY.mjs";
+  differenceBy
+} from "./chunk-LVWX5B43.mjs";
+import {
+  differenceWith
+} from "./chunk-6NVQAHXP.mjs";
 import "./chunk-2MM5EJJX.mjs";
 export {
   AbortError,
   chunk,
   clamp,
+  compact,
   debounce,
   delay,
   difference,
@@ -183,7 +196,9 @@ export {
   isNotNil,
   isNull,
   isUndefined,
+  keyBy,
   maxBy,
+  mean,
   minBy,
   noop,
   omit,
@@ -214,6 +229,7 @@ export {
   xorBy,
   xorWith,
   zip,
+  zipObject,
   zipWith
 };
 //# sourceMappingURL=index.mjs.map

package/dist/math/index.d.mts

@@ -1,4 +1,5 @@
 export { clamp } from './clamp.mjs';
+export { mean } from './mean.mjs';
 export { random } from './random.mjs';
 export { randomInt } from './randomInt.mjs';
 export { round } from './round.mjs';

package/dist/math/index.d.ts

@@ -1,4 +1,5 @@
 export { clamp } from './clamp.js';
+export { mean } from './mean.js';
 export { random } from './random.js';
 export { randomInt } from './randomInt.js';
 export { round } from './round.js';

package/dist/math/index.js

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var math_exports = {};
 __export(math_exports, {
   clamp: () => clamp,
+  mean: () => mean,
   random: () => random,
   randomInt: () => randomInt,
   range: () => range,
@@ -37,8 +38,26 @@ function clamp(value, bound1, bound2) {
   return Math.min(Math.max(value, bound1), bound2);
 }
 
+// src/math/sum.ts
+function sum(nums) {
+  let result = 0;
+  for (const num of nums) {
+    result += num;
+  }
+  return result;
+}
+
+// src/math/mean.ts
+function mean(nums) {
+  return sum(nums) / nums.length;
+}
+
 // src/math/random.ts
 function random(minimum, maximum) {
+  if (maximum == null) {
+    maximum = minimum;
+    minimum = 0;
+  }
   if (minimum >= maximum) {
     throw new Error("Invalid input: The maximum value must be greater than the minimum value.");
   }
@@ -59,15 +78,6 @@ function round(value, precision = 0) {
   return Math.round(value * multiplier) / multiplier;
 }
 
-// src/math/sum.ts
-function sum(nums) {
-  let result = 0;
-  for (const num of nums) {
-    result += num;
-  }
-  return result;
-}
-
 // src/math/range.ts
 function range(start, end, step) {
   if (end == null) {
@@ -90,6 +100,7 @@ function range(start, end, step) {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   clamp,
+  mean,
   random,
   randomInt,
   range,

package/dist/math/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/math/index.ts","../../src/math/clamp.ts","../../src/math/random.ts","../../src/math/randomInt.ts","../../src/math/round.ts","../../src/math/sum.ts","../../src/math/range.ts"],"sourcesContent":["export { clamp } from './clamp';\nexport { random } from './random';\nexport { randomInt } from './randomInt';\nexport { round } from './round';\nexport { sum } from './sum';\nexport { range } from './range';\n","/**\n * Clamps a number within the inclusive lower and upper bounds.\n *\n * This function takes a number and two bounds, and returns the number clamped within the specified bounds.\n * If only one bound is provided, it returns the minimum of the value and the bound.\n *\n * @param {number} value - The number to clamp.\n * @param {number} minimum - The minimum bound to clamp the number.\n * @param {number} maximum - The maximum bound to clamp the number.\n * @returns {number} The clamped number within the specified bounds.\n *\n * @example\n * const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5\n * const result2 = clamp(10, 5, 15); // result2 will be 10, as it is within the bounds 5 and 15\n * const result3 = clamp(2, 5, 15); // result3 will be 5, as 2 is clamped to the lower bound 5\n * const result4 = clamp(20, 5, 15); // result4 will be 15, as 20 is clamped to the upper bound 15\n */\nexport function clamp(value: number, maximum: number): number;\nexport function clamp(value: number, minimum: number, maximum: number): number;\nexport function clamp(value: number, bound1: number, bound2?: number): number {\n  if (bound2 == null) {\n    return Math.min(value, bound1);\n  }\n\n  return Math.min(Math.max(value, bound1), bound2);\n}\n","/**\n * Generate a random number within the given range.\n *\n * @param {number} minimum - The lower bound (inclusive).\n * @param {number} maximum - The upper bound (exclusive).\n * @returns {number} A random number between minimum (inclusive) and maximum (exclusive). The number can be an integer or a decimal.\n * @throws {Error} Throws an error if `maximum` is not greater than `minimum`.\n *\n * @example\n * const result1 = random(0, 5); // Returns a random number between 0 and 5.\n * const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown\n * const result3 = random(5, 5); // If the minimum is equal to the maximum, an error is thrown.\n */\nexport function random(minimum: number, maximum: number): number {\n  if (minimum >= maximum) {\n    throw new Error('Invalid input: The maximum value must be greater than the minimum value.');\n  }\n\n  return Math.random() * (maximum - minimum) + minimum;\n}\n","import { random } from './random';\n\n/**\n * Generates a random integer between minimum (inclusive) and maximum (exclusive).\n *\n * @param {number} minimum - The lower bound (inclusive).\n * @param {number} maximum - The upper bound (exclusive).\n * @returns {number} A random integer between minimum (inclusive) and maximum (exclusive).\n * @throws {Error} Throws an error if `maximum` is not greater than `minimum`.\n *\n * @example\n * const result = randomInt(0, 5); // result will be a random integer between 0 (inclusive) and 5 (exclusive)\n * const result2 = randomInt(5, 0); // This will throw an error\n */\nexport function randomInt(minimum: number, maximum: number): number {\n  return Math.floor(random(minimum, maximum));\n}\n","/**\n * Rounds a number to a specified precision.\n *\n * This function takes a number and an optional precision value, and returns the number rounded\n * to the specified number of decimal places.\n *\n * @param {number} value - The number to round.\n * @param {number} [precision=0] - The number of decimal places to round to. Defaults to 0.\n * @returns {number} The rounded number.\n * @throws {Error} Throws an error if `Precision` is not integer.\n *\n * @example\n * const result1 = round(1.2345); // result1 will be 1\n * const result2 = round(1.2345, 2); // result2 will be 1.23\n * const result3 = round(1.2345, 3); // result3 will be 1.235\n * const result4 = round(1.2345, 3.1); // This will throw an error\n */\nexport function round(value: number, precision = 0): number {\n  if (!Number.isInteger(precision)) {\n    throw new Error('Precision must be an integer.');\n  }\n  const multiplier = Math.pow(10, precision);\n  return Math.round(value * multiplier) / multiplier;\n}\n","/**\n * Calculates the sum of an array of numbers.\n *\n * This function takes an array of numbers and returns the sum of all the elements in the array.\n *\n * @param {number[]} nums - An array of numbers to be summed.\n * @returns {number} The sum of all the numbers in the array.\n *\n * @example\n * const numbers = [1, 2, 3, 4, 5];\n * const result = sum(numbers);\n * // result will be 15\n */\nexport function sum(nums: number[]): number {\n  let result = 0;\n\n  for (const num of nums) {\n    result += num;\n  }\n\n  return result;\n}\n","/**\n * Returns an array of numbers from `start` to `end`, incrementing by `step`.\n *\n * If `step` is not provided, it defaults to `1` for an\n * ascending range and `-1` for a descending range.\n *\n * @param {number} start - The starting number of the range.\n * @param {number} [end] - The end number of the range.\n * @param {number} [step] - The step value for the range.\n * @returns {number[]} An array of numbers from `start` to `end` with the specified `step`.\n *\n * @example\n * // Returns [0, 1, 2, 3]\n * range(4);\n *\n * @example\n * // Returns [0, 5, 10, 15]\n * range(0, 20, 5);\n *\n * @example\n * // Returns []\n * range(0, -4, -1);\n *\n * @example\n * // Throws an error: The step value must be a non-zero integer.\n * range(1, 4, 0);\n */\nexport function range(end: number): number[];\nexport function range(start: number, end: number): number[];\nexport function range(start: number, end: number, step: number): number[];\nexport function range(start: number, end?: number, step?: number): number[] {\n  if (end == null) {\n    end = start;\n    start = 0;\n  }\n\n  if (step == null) {\n    step = 1;\n  }\n\n  if (!Number.isInteger(step) || step === 0) {\n    throw new Error(`The step value must be a non-zero integer.`);\n  }\n\n  const length = Math.max(Math.ceil((end - start) / step), 0);\n  const result = new Array(length);\n\n  for (let i = 0; i < length; i++) {\n    result[i] = start + i * step;\n  }\n\n  return result;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACmBO,SAAS,MAAM,OAAe,QAAgB,QAAyB;AAC5E,MAAI,UAAU,MAAM;AAClB,WAAO,KAAK,IAAI,OAAO,MAAM;AAAA,EAC/B;AAEA,SAAO,KAAK,IAAI,KAAK,IAAI,OAAO,MAAM,GAAG,MAAM;AACjD;;;ACZO,SAAS,OAAO,SAAiB,SAAyB;AAC/D,MAAI,WAAW,SAAS;AACtB,UAAM,IAAI,MAAM,0EAA0E;AAAA,EAC5F;AAEA,SAAO,KAAK,OAAO,KAAK,UAAU,WAAW;AAC/C;;;ACLO,SAAS,UAAU,SAAiB,SAAyB;AAClE,SAAO,KAAK,MAAM,OAAO,SAAS,OAAO,CAAC;AAC5C;;;ACCO,SAAS,MAAM,OAAe,YAAY,GAAW;AAC1D,MAAI,CAAC,OAAO,UAAU,SAAS,GAAG;AAChC,UAAM,IAAI,MAAM,+BAA+B;AAAA,EACjD;AACA,QAAM,aAAa,KAAK,IAAI,IAAI,SAAS;AACzC,SAAO,KAAK,MAAM,QAAQ,UAAU,IAAI;AAC1C;;;ACVO,SAAS,IAAI,MAAwB;AAC1C,MAAI,SAAS;AAEb,aAAW,OAAO,MAAM;AACtB,cAAU;AAAA,EACZ;AAEA,SAAO;AACT;;;ACSO,SAAS,MAAM,OAAe,KAAc,MAAyB;AAC1E,MAAI,OAAO,MAAM;AACf,UAAM;AACN,YAAQ;AAAA,EACV;AAEA,MAAI,QAAQ,MAAM;AAChB,WAAO;AAAA,EACT;AAEA,MAAI,CAAC,OAAO,UAAU,IAAI,KAAK,SAAS,GAAG;AACzC,UAAM,IAAI,MAAM,4CAA4C;AAAA,EAC9D;AAEA,QAAM,SAAS,KAAK,IAAI,KAAK,MAAM,MAAM,SAAS,IAAI,GAAG,CAAC;AAC1D,QAAM,SAAS,IAAI,MAAM,MAAM;AAE/B,WAAS,IAAI,GAAG,IAAI,QAAQ,KAAK;AAC/B,WAAO,CAAC,IAAI,QAAQ,IAAI;AAAA,EAC1B;AAEA,SAAO;AACT;","names":[]}
+{"version":3,"sources":["../../src/math/index.ts","../../src/math/clamp.ts","../../src/math/sum.ts","../../src/math/mean.ts","../../src/math/random.ts","../../src/math/randomInt.ts","../../src/math/round.ts","../../src/math/range.ts"],"sourcesContent":["export { clamp } from './clamp';\nexport { mean } from './mean';\nexport { random } from './random';\nexport { randomInt } from './randomInt';\nexport { round } from './round';\nexport { sum } from './sum';\nexport { range } from './range';\n","/**\n * Clamps a number within the inclusive lower and upper bounds.\n *\n * This function takes a number and two bounds, and returns the number clamped within the specified bounds.\n * If only one bound is provided, it returns the minimum of the value and the bound.\n *\n * @param {number} value - The number to clamp.\n * @param {number} minimum - The minimum bound to clamp the number.\n * @param {number} maximum - The maximum bound to clamp the number.\n * @returns {number} The clamped number within the specified bounds.\n *\n * @example\n * const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5\n * const result2 = clamp(10, 5, 15); // result2 will be 10, as it is within the bounds 5 and 15\n * const result3 = clamp(2, 5, 15); // result3 will be 5, as 2 is clamped to the lower bound 5\n * const result4 = clamp(20, 5, 15); // result4 will be 15, as 20 is clamped to the upper bound 15\n */\nexport function clamp(value: number, maximum: number): number;\nexport function clamp(value: number, minimum: number, maximum: number): number;\nexport function clamp(value: number, bound1: number, bound2?: number): number {\n  if (bound2 == null) {\n    return Math.min(value, bound1);\n  }\n\n  return Math.min(Math.max(value, bound1), bound2);\n}\n","/**\n * Calculates the sum of an array of numbers.\n *\n * This function takes an array of numbers and returns the sum of all the elements in the array.\n *\n * @param {number[]} nums - An array of numbers to be summed.\n * @returns {number} The sum of all the numbers in the array.\n *\n * @example\n * const numbers = [1, 2, 3, 4, 5];\n * const result = sum(numbers);\n * // result will be 15\n */\nexport function sum(nums: readonly number[]): number {\n  let result = 0;\n\n  for (const num of nums) {\n    result += num;\n  }\n\n  return result;\n}\n","import { sum } from './sum';\n\n/**\n * Calculates the average of an array of numbers.\n *\n * If the array is empty, this function returns `NaN`.\n *\n * @param {number[]} nums - An array of numbers to calculate the avverage.\n * @returns {number} The average of all the numbers in the array.\n *\n * @example\n * const numbers = [1, 2, 3, 4, 5];\n * const result = average(numbers);\n * // result will be 3\n */\nexport function mean(nums: readonly number[]): number {\n  return sum(nums) / nums.length;\n}\n","/**\n * Generate a random number within the given range.\n *\n * If only one argument is provided, a number between `0` and the given number is returned.\n *\n * @param {number} minimum - The lower bound (inclusive).\n * @param {number} maximum - The upper bound (exclusive).\n * @returns {number} A random number between minimum (inclusive) and maximum (exclusive). The number can be an integer or a decimal.\n * @throws {Error} Throws an error if `maximum` is not greater than `minimum`.\n *\n * @example\n * const result1 = random(0, 5); // Returns a random number between 0 and 5.\n * const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown\n * const result3 = random(5, 5); // If the minimum is equal to the maximum, an error is thrown.\n */\nexport function random(maximum: number): number;\nexport function random(minimum: number, maximum: number): number;\nexport function random(minimum: number, maximum?: number): number {\n  if (maximum == null) {\n    maximum = minimum;\n    minimum = 0;\n  }\n\n  if (minimum >= maximum) {\n    throw new Error('Invalid input: The maximum value must be greater than the minimum value.');\n  }\n\n  return Math.random() * (maximum - minimum) + minimum;\n}\n","import { random } from './random';\n\n/**\n * Generates a random integer between minimum (inclusive) and maximum (exclusive).\n *\n * If only one argument is provided, a number between `0` and the given number is returned.\n *\n * @param {number} minimum - The lower bound (inclusive).\n * @param {number} maximum - The upper bound (exclusive).\n * @returns {number} A random integer between minimum (inclusive) and maximum (exclusive).\n * @throws {Error} Throws an error if `maximum` is not greater than `minimum`.\n *\n * @example\n * const result = randomInt(0, 5); // result will be a random integer between 0 (inclusive) and 5 (exclusive)\n * const result2 = randomInt(5, 0); // This will throw an error\n */\nexport function randomInt(maximum: number): number;\nexport function randomInt(minimum: number, maximum: number): number;\nexport function randomInt(minimum: number, maximum?: number): number {\n  return Math.floor(random(minimum, maximum!));\n}\n","/**\n * Rounds a number to a specified precision.\n *\n * This function takes a number and an optional precision value, and returns the number rounded\n * to the specified number of decimal places.\n *\n * @param {number} value - The number to round.\n * @param {number} [precision=0] - The number of decimal places to round to. Defaults to 0.\n * @returns {number} The rounded number.\n * @throws {Error} Throws an error if `Precision` is not integer.\n *\n * @example\n * const result1 = round(1.2345); // result1 will be 1\n * const result2 = round(1.2345, 2); // result2 will be 1.23\n * const result3 = round(1.2345, 3); // result3 will be 1.235\n * const result4 = round(1.2345, 3.1); // This will throw an error\n */\nexport function round(value: number, precision = 0): number {\n  if (!Number.isInteger(precision)) {\n    throw new Error('Precision must be an integer.');\n  }\n  const multiplier = Math.pow(10, precision);\n  return Math.round(value * multiplier) / multiplier;\n}\n","/**\n * Returns an array of numbers from `start` to `end`, incrementing by `step`.\n *\n * If `step` is not provided, it defaults to `1` for an\n * ascending range and `-1` for a descending range.\n *\n * @param {number} start - The starting number of the range.\n * @param {number} [end] - The end number of the range.\n * @param {number} [step] - The step value for the range.\n * @returns {number[]} An array of numbers from `start` to `end` with the specified `step`.\n *\n * @example\n * // Returns [0, 1, 2, 3]\n * range(4);\n *\n * @example\n * // Returns [0, 5, 10, 15]\n * range(0, 20, 5);\n *\n * @example\n * // Returns []\n * range(0, -4, -1);\n *\n * @example\n * // Throws an error: The step value must be a non-zero integer.\n * range(1, 4, 0);\n */\nexport function range(end: number): number[];\nexport function range(start: number, end: number): number[];\nexport function range(start: number, end: number, step: number): number[];\nexport function range(start: number, end?: number, step?: number): number[] {\n  if (end == null) {\n    end = start;\n    start = 0;\n  }\n\n  if (step == null) {\n    step = 1;\n  }\n\n  if (!Number.isInteger(step) || step === 0) {\n    throw new Error(`The step value must be a non-zero integer.`);\n  }\n\n  const length = Math.max(Math.ceil((end - start) / step), 0);\n  const result = new Array(length);\n\n  for (let i = 0; i < length; i++) {\n    result[i] = start + i * step;\n  }\n\n  return result;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACmBO,SAAS,MAAM,OAAe,QAAgB,QAAyB;AAC5E,MAAI,UAAU,MAAM;AAClB,WAAO,KAAK,IAAI,OAAO,MAAM;AAAA,EAC/B;AAEA,SAAO,KAAK,IAAI,KAAK,IAAI,OAAO,MAAM,GAAG,MAAM;AACjD;;;ACZO,SAAS,IAAI,MAAiC;AACnD,MAAI,SAAS;AAEb,aAAW,OAAO,MAAM;AACtB,cAAU;AAAA,EACZ;AAEA,SAAO;AACT;;;ACNO,SAAS,KAAK,MAAiC;AACpD,SAAO,IAAI,IAAI,IAAI,KAAK;AAC1B;;;ACAO,SAAS,OAAO,SAAiB,SAA0B;AAChE,MAAI,WAAW,MAAM;AACnB,cAAU;AACV,cAAU;AAAA,EACZ;AAEA,MAAI,WAAW,SAAS;AACtB,UAAM,IAAI,MAAM,0EAA0E;AAAA,EAC5F;AAEA,SAAO,KAAK,OAAO,KAAK,UAAU,WAAW;AAC/C;;;ACVO,SAAS,UAAU,SAAiB,SAA0B;AACnE,SAAO,KAAK,MAAM,OAAO,SAAS,OAAQ,CAAC;AAC7C;;;ACHO,SAAS,MAAM,OAAe,YAAY,GAAW;AAC1D,MAAI,CAAC,OAAO,UAAU,SAAS,GAAG;AAChC,UAAM,IAAI,MAAM,+BAA+B;AAAA,EACjD;AACA,QAAM,aAAa,KAAK,IAAI,IAAI,SAAS;AACzC,SAAO,KAAK,MAAM,QAAQ,UAAU,IAAI;AAC1C;;;ACOO,SAAS,MAAM,OAAe,KAAc,MAAyB;AAC1E,MAAI,OAAO,MAAM;AACf,UAAM;AACN,YAAQ;AAAA,EACV;AAEA,MAAI,QAAQ,MAAM;AAChB,WAAO;AAAA,EACT;AAEA,MAAI,CAAC,OAAO,UAAU,IAAI,KAAK,SAAS,GAAG;AACzC,UAAM,IAAI,MAAM,4CAA4C;AAAA,EAC9D;AAEA,QAAM,SAAS,KAAK,IAAI,KAAK,MAAM,MAAM,SAAS,IAAI,GAAG,CAAC;AAC1D,QAAM,SAAS,IAAI,MAAM,MAAM;AAE/B,WAAS,IAAI,GAAG,IAAI,QAAQ,KAAK;AAC/B,WAAO,CAAC,IAAI,QAAQ,IAAI;AAAA,EAC1B;AAEA,SAAO;AACT;","names":[]}

package/dist/math/index.mjs

@@ -1,25 +1,29 @@
-import "../chunk-7LAMAYGN.mjs";
-import {
-  clamp
-} from "../chunk-MLCL773E.mjs";
+import "../chunk-QVHWSUEH.mjs";
 import {
   randomInt
-} from "../chunk-5UT77WON.mjs";
-import {
-  random
-} from "../chunk-LCP6FOCX.mjs";
+} from "../chunk-WC5HFQXP.mjs";
 import {
   range
 } from "../chunk-UNLX2F2Y.mjs";
 import {
   round
 } from "../chunk-5PMKOZ2F.mjs";
+import {
+  clamp
+} from "../chunk-MLCL773E.mjs";
+import {
+  mean
+} from "../chunk-S3GNYAM2.mjs";
 import {
   sum
-} from "../chunk-7OU22ENP.mjs";
+} from "../chunk-NOFHNJ5C.mjs";
+import {
+  random
+} from "../chunk-SYWMYQYJ.mjs";
 import "../chunk-2MM5EJJX.mjs";
 export {
   clamp,
+  mean,
   random,
   randomInt,
   range,

package/dist/math/mean.d.mts

@@ -0,0 +1,16 @@
+/**
+ * Calculates the average of an array of numbers.
+ *
+ * If the array is empty, this function returns `NaN`.
+ *
+ * @param {number[]} nums - An array of numbers to calculate the avverage.
+ * @returns {number} The average of all the numbers in the array.
+ *
+ * @example
+ * const numbers = [1, 2, 3, 4, 5];
+ * const result = average(numbers);
+ * // result will be 3
+ */
+declare function mean(nums: readonly number[]): number;
+
+export { mean };

package/dist/math/mean.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Calculates the average of an array of numbers.
+ *
+ * If the array is empty, this function returns `NaN`.
+ *
+ * @param {number[]} nums - An array of numbers to calculate the avverage.
+ * @returns {number} The average of all the numbers in the array.
+ *
+ * @example
+ * const numbers = [1, 2, 3, 4, 5];
+ * const result = average(numbers);
+ * // result will be 3
+ */
+declare function mean(nums: readonly number[]): number;
+
+export { mean };

package/dist/math/mean.js

@@ -0,0 +1,44 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/math/mean.ts
+var mean_exports = {};
+__export(mean_exports, {
+  mean: () => mean
+});
+module.exports = __toCommonJS(mean_exports);
+
+// src/math/sum.ts
+function sum(nums) {
+  let result = 0;
+  for (const num of nums) {
+    result += num;
+  }
+  return result;
+}
+
+// src/math/mean.ts
+function mean(nums) {
+  return sum(nums) / nums.length;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  mean
+});
+//# sourceMappingURL=mean.js.map

package/dist/math/mean.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/math/mean.ts","../../src/math/sum.ts"],"sourcesContent":["import { sum } from './sum';\n\n/**\n * Calculates the average of an array of numbers.\n *\n * If the array is empty, this function returns `NaN`.\n *\n * @param {number[]} nums - An array of numbers to calculate the avverage.\n * @returns {number} The average of all the numbers in the array.\n *\n * @example\n * const numbers = [1, 2, 3, 4, 5];\n * const result = average(numbers);\n * // result will be 3\n */\nexport function mean(nums: readonly number[]): number {\n  return sum(nums) / nums.length;\n}\n","/**\n * Calculates the sum of an array of numbers.\n *\n * This function takes an array of numbers and returns the sum of all the elements in the array.\n *\n * @param {number[]} nums - An array of numbers to be summed.\n * @returns {number} The sum of all the numbers in the array.\n *\n * @example\n * const numbers = [1, 2, 3, 4, 5];\n * const result = sum(numbers);\n * // result will be 15\n */\nexport function sum(nums: readonly number[]): number {\n  let result = 0;\n\n  for (const num of nums) {\n    result += num;\n  }\n\n  return result;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACaO,SAAS,IAAI,MAAiC;AACnD,MAAI,SAAS;AAEb,aAAW,OAAO,MAAM;AACtB,cAAU;AAAA,EACZ;AAEA,SAAO;AACT;;;ADNO,SAAS,KAAK,MAAiC;AACpD,SAAO,IAAI,IAAI,IAAI,KAAK;AAC1B;","names":[]}

package/dist/math/mean.mjs

@@ -0,0 +1,9 @@
+import {
+  mean
+} from "../chunk-S3GNYAM2.mjs";
+import "../chunk-NOFHNJ5C.mjs";
+import "../chunk-2MM5EJJX.mjs";
+export {
+  mean
+};
+//# sourceMappingURL=mean.mjs.map

package/dist/math/mean.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/math/random.d.mts

@@ -1,6 +1,8 @@
 /**
  * Generate a random number within the given range.
  *
+ * If only one argument is provided, a number between `0` and the given number is returned.
+ *
  * @param {number} minimum - The lower bound (inclusive).
  * @param {number} maximum - The upper bound (exclusive).
  * @returns {number} A random number between minimum (inclusive) and maximum (exclusive). The number can be an integer or a decimal.
@@ -11,6 +13,7 @@
  * const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown
  * const result3 = random(5, 5); // If the minimum is equal to the maximum, an error is thrown.
  */
+declare function random(maximum: number): number;
 declare function random(minimum: number, maximum: number): number;
 
 export { random };

package/dist/math/random.d.ts

@@ -1,6 +1,8 @@
 /**
  * Generate a random number within the given range.
  *
+ * If only one argument is provided, a number between `0` and the given number is returned.
+ *
  * @param {number} minimum - The lower bound (inclusive).
  * @param {number} maximum - The upper bound (exclusive).
  * @returns {number} A random number between minimum (inclusive) and maximum (exclusive). The number can be an integer or a decimal.
@@ -11,6 +13,7 @@
  * const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown
  * const result3 = random(5, 5); // If the minimum is equal to the maximum, an error is thrown.
  */
+declare function random(maximum: number): number;
 declare function random(minimum: number, maximum: number): number;
 
 export { random };

package/dist/math/random.js

@@ -24,6 +24,10 @@ __export(random_exports, {
 });
 module.exports = __toCommonJS(random_exports);
 function random(minimum, maximum) {
+  if (maximum == null) {
+    maximum = minimum;
+    minimum = 0;
+  }
   if (minimum >= maximum) {
     throw new Error("Invalid input: The maximum value must be greater than the minimum value.");
   }

package/dist/math/random.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/math/random.ts"],"sourcesContent":["/**\n * Generate a random number within the given range.\n *\n * @param {number} minimum - The lower bound (inclusive).\n * @param {number} maximum - The upper bound (exclusive).\n * @returns {number} A random number between minimum (inclusive) and maximum (exclusive). The number can be an integer or a decimal.\n * @throws {Error} Throws an error if `maximum` is not greater than `minimum`.\n *\n * @example\n * const result1 = random(0, 5); // Returns a random number between 0 and 5.\n * const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown\n * const result3 = random(5, 5); // If the minimum is equal to the maximum, an error is thrown.\n */\nexport function random(minimum: number, maximum: number): number {\n  if (minimum >= maximum) {\n    throw new Error('Invalid input: The maximum value must be greater than the minimum value.');\n  }\n\n  return Math.random() * (maximum - minimum) + minimum;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAaO,SAAS,OAAO,SAAiB,SAAyB;AAC/D,MAAI,WAAW,SAAS;AACtB,UAAM,IAAI,MAAM,0EAA0E;AAAA,EAC5F;AAEA,SAAO,KAAK,OAAO,KAAK,UAAU,WAAW;AAC/C;","names":[]}
+{"version":3,"sources":["../../src/math/random.ts"],"sourcesContent":["/**\n * Generate a random number within the given range.\n *\n * If only one argument is provided, a number between `0` and the given number is returned.\n *\n * @param {number} minimum - The lower bound (inclusive).\n * @param {number} maximum - The upper bound (exclusive).\n * @returns {number} A random number between minimum (inclusive) and maximum (exclusive). The number can be an integer or a decimal.\n * @throws {Error} Throws an error if `maximum` is not greater than `minimum`.\n *\n * @example\n * const result1 = random(0, 5); // Returns a random number between 0 and 5.\n * const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown\n * const result3 = random(5, 5); // If the minimum is equal to the maximum, an error is thrown.\n */\nexport function random(maximum: number): number;\nexport function random(minimum: number, maximum: number): number;\nexport function random(minimum: number, maximum?: number): number {\n  if (maximum == null) {\n    maximum = minimum;\n    minimum = 0;\n  }\n\n  if (minimum >= maximum) {\n    throw new Error('Invalid input: The maximum value must be greater than the minimum value.');\n  }\n\n  return Math.random() * (maximum - minimum) + minimum;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAiBO,SAAS,OAAO,SAAiB,SAA0B;AAChE,MAAI,WAAW,MAAM;AACnB,cAAU;AACV,cAAU;AAAA,EACZ;AAEA,MAAI,WAAW,SAAS;AACtB,UAAM,IAAI,MAAM,0EAA0E;AAAA,EAC5F;AAEA,SAAO,KAAK,OAAO,KAAK,UAAU,WAAW;AAC/C;","names":[]}

package/dist/math/random.mjs

@@ -1,6 +1,6 @@
 import {
   random
-} from "../chunk-LCP6FOCX.mjs";
+} from "../chunk-SYWMYQYJ.mjs";
 import "../chunk-2MM5EJJX.mjs";
 export {
   random

package/dist/math/randomInt.d.mts

@@ -1,6 +1,8 @@
 /**
  * Generates a random integer between minimum (inclusive) and maximum (exclusive).
  *
+ * If only one argument is provided, a number between `0` and the given number is returned.
+ *
  * @param {number} minimum - The lower bound (inclusive).
  * @param {number} maximum - The upper bound (exclusive).
  * @returns {number} A random integer between minimum (inclusive) and maximum (exclusive).
@@ -10,6 +12,7 @@
  * const result = randomInt(0, 5); // result will be a random integer between 0 (inclusive) and 5 (exclusive)
  * const result2 = randomInt(5, 0); // This will throw an error
  */
+declare function randomInt(maximum: number): number;
 declare function randomInt(minimum: number, maximum: number): number;
 
 export { randomInt };

package/dist/math/randomInt.d.ts

@@ -1,6 +1,8 @@
 /**
  * Generates a random integer between minimum (inclusive) and maximum (exclusive).
  *
+ * If only one argument is provided, a number between `0` and the given number is returned.
+ *
  * @param {number} minimum - The lower bound (inclusive).
  * @param {number} maximum - The upper bound (exclusive).
  * @returns {number} A random integer between minimum (inclusive) and maximum (exclusive).
@@ -10,6 +12,7 @@
  * const result = randomInt(0, 5); // result will be a random integer between 0 (inclusive) and 5 (exclusive)
  * const result2 = randomInt(5, 0); // This will throw an error
  */
+declare function randomInt(maximum: number): number;
 declare function randomInt(minimum: number, maximum: number): number;
 
 export { randomInt };

package/dist/math/randomInt.js

@@ -26,6 +26,10 @@ module.exports = __toCommonJS(randomInt_exports);
 
 // src/math/random.ts
 function random(minimum, maximum) {
+  if (maximum == null) {
+    maximum = minimum;
+    minimum = 0;
+  }
   if (minimum >= maximum) {
     throw new Error("Invalid input: The maximum value must be greater than the minimum value.");
   }

package/dist/math/randomInt.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/math/randomInt.ts","../../src/math/random.ts"],"sourcesContent":["import { random } from './random';\n\n/**\n * Generates a random integer between minimum (inclusive) and maximum (exclusive).\n *\n * @param {number} minimum - The lower bound (inclusive).\n * @param {number} maximum - The upper bound (exclusive).\n * @returns {number} A random integer between minimum (inclusive) and maximum (exclusive).\n * @throws {Error} Throws an error if `maximum` is not greater than `minimum`.\n *\n * @example\n * const result = randomInt(0, 5); // result will be a random integer between 0 (inclusive) and 5 (exclusive)\n * const result2 = randomInt(5, 0); // This will throw an error\n */\nexport function randomInt(minimum: number, maximum: number): number {\n  return Math.floor(random(minimum, maximum));\n}\n","/**\n * Generate a random number within the given range.\n *\n * @param {number} minimum - The lower bound (inclusive).\n * @param {number} maximum - The upper bound (exclusive).\n * @returns {number} A random number between minimum (inclusive) and maximum (exclusive). The number can be an integer or a decimal.\n * @throws {Error} Throws an error if `maximum` is not greater than `minimum`.\n *\n * @example\n * const result1 = random(0, 5); // Returns a random number between 0 and 5.\n * const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown\n * const result3 = random(5, 5); // If the minimum is equal to the maximum, an error is thrown.\n */\nexport function random(minimum: number, maximum: number): number {\n  if (minimum >= maximum) {\n    throw new Error('Invalid input: The maximum value must be greater than the minimum value.');\n  }\n\n  return Math.random() * (maximum - minimum) + minimum;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACaO,SAAS,OAAO,SAAiB,SAAyB;AAC/D,MAAI,WAAW,SAAS;AACtB,UAAM,IAAI,MAAM,0EAA0E;AAAA,EAC5F;AAEA,SAAO,KAAK,OAAO,KAAK,UAAU,WAAW;AAC/C;;;ADLO,SAAS,UAAU,SAAiB,SAAyB;AAClE,SAAO,KAAK,MAAM,OAAO,SAAS,OAAO,CAAC;AAC5C;","names":[]}
+{"version":3,"sources":["../../src/math/randomInt.ts","../../src/math/random.ts"],"sourcesContent":["import { random } from './random';\n\n/**\n * Generates a random integer between minimum (inclusive) and maximum (exclusive).\n *\n * If only one argument is provided, a number between `0` and the given number is returned.\n *\n * @param {number} minimum - The lower bound (inclusive).\n * @param {number} maximum - The upper bound (exclusive).\n * @returns {number} A random integer between minimum (inclusive) and maximum (exclusive).\n * @throws {Error} Throws an error if `maximum` is not greater than `minimum`.\n *\n * @example\n * const result = randomInt(0, 5); // result will be a random integer between 0 (inclusive) and 5 (exclusive)\n * const result2 = randomInt(5, 0); // This will throw an error\n */\nexport function randomInt(maximum: number): number;\nexport function randomInt(minimum: number, maximum: number): number;\nexport function randomInt(minimum: number, maximum?: number): number {\n  return Math.floor(random(minimum, maximum!));\n}\n","/**\n * Generate a random number within the given range.\n *\n * If only one argument is provided, a number between `0` and the given number is returned.\n *\n * @param {number} minimum - The lower bound (inclusive).\n * @param {number} maximum - The upper bound (exclusive).\n * @returns {number} A random number between minimum (inclusive) and maximum (exclusive). The number can be an integer or a decimal.\n * @throws {Error} Throws an error if `maximum` is not greater than `minimum`.\n *\n * @example\n * const result1 = random(0, 5); // Returns a random number between 0 and 5.\n * const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown\n * const result3 = random(5, 5); // If the minimum is equal to the maximum, an error is thrown.\n */\nexport function random(maximum: number): number;\nexport function random(minimum: number, maximum: number): number;\nexport function random(minimum: number, maximum?: number): number {\n  if (maximum == null) {\n    maximum = minimum;\n    minimum = 0;\n  }\n\n  if (minimum >= maximum) {\n    throw new Error('Invalid input: The maximum value must be greater than the minimum value.');\n  }\n\n  return Math.random() * (maximum - minimum) + minimum;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACiBO,SAAS,OAAO,SAAiB,SAA0B;AAChE,MAAI,WAAW,MAAM;AACnB,cAAU;AACV,cAAU;AAAA,EACZ;AAEA,MAAI,WAAW,SAAS;AACtB,UAAM,IAAI,MAAM,0EAA0E;AAAA,EAC5F;AAEA,SAAO,KAAK,OAAO,KAAK,UAAU,WAAW;AAC/C;;;ADVO,SAAS,UAAU,SAAiB,SAA0B;AACnE,SAAO,KAAK,MAAM,OAAO,SAAS,OAAQ,CAAC;AAC7C;","names":[]}

package/dist/math/randomInt.mjs

@@ -1,7 +1,7 @@
 import {
   randomInt
-} from "../chunk-5UT77WON.mjs";
-import "../chunk-LCP6FOCX.mjs";
+} from "../chunk-WC5HFQXP.mjs";
+import "../chunk-SYWMYQYJ.mjs";
 import "../chunk-2MM5EJJX.mjs";
 export {
   randomInt

package/dist/math/sum.d.mts

@@ -11,6 +11,6 @@
  * const result = sum(numbers);
  * // result will be 15
  */
-declare function sum(nums: number[]): number;
+declare function sum(nums: readonly number[]): number;
 
 export { sum };

package/dist/math/sum.d.ts

@@ -11,6 +11,6 @@
  * const result = sum(numbers);
  * // result will be 15
  */
-declare function sum(nums: number[]): number;
+declare function sum(nums: readonly number[]): number;
 
 export { sum };