All files / src/validators max.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 4x 1x    
import { Validator } from "../types";
 
/**
 * Given a number checks it against an expected maximum.
 *
 * @example
 *
 * ```ts
 * import { max } from 'compose-validators';
 *
 * const validate = max(10);
 *
 * validate(15) // => { max: 10 }
 * validate(10) // => {}
 * ```
 *
 * @param num expected maximum number
 */
export const max = (num: number): Validator<number> => (value: number) => {
  if (value <= num) return {};
  return { max: num };
};