predictype

predictype v0.8.1


predictype / predicates/numbers/numberRange / numberRange

Function: numberRange()

numberRange(source, oper, min, max): boolean

Defined in: predicates/numbers/numberRange.ts:27

Checks if a number is in or outside a range using the specified operation.

Parameters

source

number

The number to check.

oper

NumberRangeOper

The range operation to perform (e.g. ‘in_range’, ‘strict_in_range’).

min

number

The minimum value (inclusive or exclusive depending on operation).

max

number

The maximum value (inclusive or exclusive depending on operation).

Returns

boolean

True if the range check is valid according to the operator, otherwise false.

Throws

If the operation is not recognized.

Example

const n = 5;

numberRange(n, 'in_range', 1, 10); // true
numberRange(n, 'strict_in_range', 5, 10); // false

Remarks

Supported Operators: