28 lines
No EOL
1 KiB
TypeScript
28 lines
No EOL
1 KiB
TypeScript
//#region src/math/inRange.d.ts
|
|
/**
|
|
* Checks if the value is less than the maximum.
|
|
*
|
|
* @param value The value to check.
|
|
* @param maximum The upper bound of the range (exclusive).
|
|
* @returns `true` if the value is less than the maximum, otherwise `false`.
|
|
*
|
|
* @example
|
|
* const result = inRange(3, 5); // result will be true.
|
|
* const result2 = inRange(5, 5); // result2 will be false.
|
|
*/
|
|
declare function inRange(value: number, maximum: number): boolean;
|
|
/**
|
|
* Checks if the value is within the range defined by minimum (inclusive) and maximum (exclusive).
|
|
*
|
|
* @param value The value to check.
|
|
* @param minimum The lower bound of the range (inclusive).
|
|
* @param maximum The upper bound of the range (exclusive).
|
|
* @returns `true` if the value is within the specified range, otherwise `false`.
|
|
*
|
|
* @example
|
|
* const result = inRange(3, 2, 5); // result will be true.
|
|
* const result2 = inRange(1, 2, 5); // result2 will be false.
|
|
*/
|
|
declare function inRange(value: number, minimum: number, maximum: number): boolean;
|
|
//#endregion
|
|
export { inRange }; |