Function compare

compare(
    value: number,
    conditions:
        | string
        | string[]
        | {
            between?: [number, number];
            eq?: number;
            gt?: number;
            gte?: number;
            in?: number[];
            lt?: number;
            lte?: number;
            ne?: number;
        }
        | PCompareString[],
): boolean
Compares a number against one or more conditional expressions.
Parameters
- value: number
  The number to evaluate.
- conditions:
      | string
      | string[]
      | {
          between?: [number, number];
          eq?: number;
          gt?: number;
          gte?: number;
          in?: number[];
          lt?: number;
          lte?: number;
          ne?: number;
      }
      | PCompareString[]
  Conditions to apply:
  
  A a string like '>10', '<=50' or '!=0'.
  
  An array of string like ['>10', '<=50'].
  
  An object specifying one or more keys from the following:
  
  ne: not equal to
  
  eq: equal to
  
  lt: less than
  
  lte: less than or equal to
  
  gt: greater than
  
  gte: greater than or equal to
  
  in: value must be included in the provided array
  
  between: value must be between two numbers
Returns boolean
true if all conditions in params evaluate to true for the given value; otherwise, false.
Example
```
console.log(PUtilsNumber.compare(45, '>10')) // true
console.log(PUtilsNumber.compare(45, '>50')) // false
console.log(PUtilsNumber.compare(45, ['>10', '<50'])) // true
console.log(PUtilsNumber.compare(45, '!10')) // true
console.log(PUtilsNumber.compare(45, '=45')) // true
console.log(PUtilsNumber.compare(45, { gt: 10, lte: 50 }))          // true
console.log(PUtilsNumber.compare(45, { in: [30, 40, 45, 50] }))     // true
```
- Defined in putils/number.ts:306

Function compare

Parameters

Returns boolean

Example

Settings