All files / src/validators min.ts

100% Statements 5/5
100% Branches 2/2
100% Functions 2/2
100% Lines 3/3

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23                                    10x 5x 2x    
import { Validator } from "../types";
 
/**
 * Given a number checks it against an expected minimum.
 *
 * @example
 *
 * ```ts
 * import { min } from 'compose-validators';
 *
 * const validate = min(10);
 *
 * validate(9) // => { min: 10 }
 * validate(10) // => {}
 * ```
 *
 * @param num expected minimum number
 */
export const min = (num: number): Validator<number> => (value: number) => {
  if (value >= num) return {};
  return { min: num };
};