26 lines
994 B
JavaScript
26 lines
994 B
JavaScript
//#region src/math/inRange.ts
|
|
/**
|
|
* Checks if the value is within a specified range.
|
|
*
|
|
* @param {number} value The value to check.
|
|
* @param {number} minimum The lower bound of the range (inclusive).
|
|
* @param {number} maximum The upper bound of the range (exclusive).
|
|
* @returns {boolean} `true` if the value is within the specified range, otherwise `false`.
|
|
* @throws {Error} Throws an error if the `minimum` is greater or equal than the `maximum`.
|
|
*
|
|
* @example
|
|
* const result1 = inRange(3, 5); // result1 will be true.
|
|
* const result2 = inRange(1, 2, 5); // result2 will be false.
|
|
* const result3 = inRange(1, 5, 2); // If the minimum is greater or equal than the maximum, an error is thrown.
|
|
*/
|
|
function inRange(value, minimum, maximum) {
|
|
if (maximum == null) {
|
|
maximum = minimum;
|
|
minimum = 0;
|
|
}
|
|
if (minimum >= maximum) throw new Error("The maximum value must be greater than the minimum value.");
|
|
return minimum <= value && value < maximum;
|
|
}
|
|
//#endregion
|
|
exports.inRange = inRange;
|