@inglorious/utils 3.4.0 → 3.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inglorious/utils",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "A set of general-purpose utility functions designed with functional programming principles in mind.",
   "author": "IceOnFire <antony.mistretta@gmail.com> (https://ingloriouscoderz.it)",
   "license": "MIT",

package/src/math/rng.js

@@ -16,20 +16,32 @@ export function choose(...values) {
 /**
  * Generates a random number.
  * - If no arguments are provided, returns a random float between 0 (inclusive) and 1 (exclusive).
- * - If one argument is provided, returns a random integer between 0 and the given number (inclusive).
- * - If two or more arguments are provided, returns a random integer within the specified range and step.
- * @param {number} [to] - The upper bound (inclusive) if one argument is provided.
- * @param {number} [from] - The lower bound (inclusive) if two arguments are provided.
+ * - If one argument (`to`) is provided, returns a random integer between 0 and `to` (inclusive).
+ * - If two arguments (`from`, `to`) are provided:
+ *   - If they are integers, returns a random integer between `from` and `to` (inclusive).
+ *   - If they are floats, returns a random float between `from` (inclusive) and `to` (exclusive).
+ * - If three arguments (`from`, `to`, `step`) are provided, returns a random integer within the specified range and step.
+ * @param {number} [to] - The upper bound.
+ * @param {number} [from] - The lower bound.
  * @param {number} [step=1] - The step size if two or more arguments are provided.
  * @returns {number} A random number based on the provided arguments.
  */
 export function random(...args) {
-  let step, from, to
-
   if (!args.length) {
     return Math.random()
   }
 
+  if (
+    args.length > 1 &&
+    !Number.isInteger(args[0]) &&
+    !Number.isInteger(args[1])
+  ) {
+    const [from, to] = args
+    return Math.random() * (to - from) + from
+  }
+
+  let step, from, to
+
   if (args.length === 1) {
     step = 1
     from = 0

package/src/math/rng.test.js

@@ -38,6 +38,15 @@ test("it should create a random even number in the range [2, 6]", () => {
   expect(randomNumber % 2).toBe(0)
 })
 
+test("it should create a random float in the range [1.5, 6.5)", () => {
+  const from = 1.5
+  const to = 6.5
+  const randomNumber = random(from, to)
+
+  expect(randomNumber).toBeGreaterThanOrEqual(from)
+  expect(randomNumber).toBeLessThan(to)
+})
+
 test("it should create a random number in the range (-1, 1)", () => {
   const randomNumber = randomBinomial()