predictype

predictype v0.8.1


predictype / predicates/numbers/numberComparison / numberComparison

Function: numberComparison()

numberComparison(source, oper, target): boolean

Defined in: predicates/numbers/numberComparison.ts:30

Compares two numbers using the specified operation.

Parameters

source

number

The first number.

oper

NumberComparisonOper

The comparison operation to perform (e.g. ‘greater_than’, ‘equals’).

target

number

The second number.

Returns

boolean

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

Throws

If the operation is not recognized.

Example

const a = 5;
const b = 10;

numberComparison(a, 'less_than', b); // true
numberComparison(a, 'greater_than', b); // false
numberComparison(a, 'equals', 5); // true

Remarks

Supported Operators: