25 lines
1002 B
JavaScript
25 lines
1002 B
JavaScript
|
//#region src/math/random.ts
|
||
|
|
/**
|
||
|
|
* Generate a random number within the given range.
|
||
|
|
*
|
||
|
|
* @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.
|
||
|
|
* @throws {Error} Throws an error if `maximum` is not greater than `minimum`.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* const result1 = random(0, 5); // Returns a random number between 0 and 5.
|
||
|
|
* 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.
|
||
|
|
*/
|
||
|
|
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.");
|
||
|
|
return Math.random() * (maximum - minimum) + minimum;
|
||
|
|
}
|
||
|
|
//#endregion
|
||
|
|
export { random };
|