isInRange

1/**
2 * Checks if a number is within the given inclusive range.
3 *
4 * @param num - The number to check.
5 * @param min - The minimum allowed value.
6 * @param max - The maximum allowed value.
7 * @returns True if num is between min and max (inclusive), false otherwise.
8 * @throws If min is greater than max.
9 */
10export function isInRange(num: number, min: number, max: number): boolean {
11  if (min > max) {
12    throw new Error('"min" should not be greater than "max"');
13  }
14  return num >= min && num <= max;
15}

1test('isInRange - inside range', () => {
2  expect(isInRange(5, 1, 10)).toBe(true);
3});
4
5test('isInRange - on lower bound', () => {
6  expect(isInRange(1, 1, 10)).toBe(true);
7});
8
9test('isInRange - on upper bound', () => {
10  expect(isInRange(10, 1, 10)).toBe(true);
11});
12
13test('isInRange - below range', () => {
14  expect(isInRange(0, 1, 10)).toBe(false);
15});
16
17test('isInRange - above range', () => {
18  expect(isInRange(11, 1, 10)).toBe(false);
19});
20
21test('isInRange - throws if min > max', () => {
22  expect(() => isInRange(5, 10, 1)).toThrow('"min" should not be greater than "max"');
23});