All files / number/src isPositive.ts

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

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                                3x 3x    
import { Predicate } from "@benneq/predicate";
 
/**
 * Checks if a {@link Number} is positive.
 *
 * @example
 * Returns `true` if number is `> 0`
 * ```ts
 * const result = isPositive(1);
 *
 * console.log(result); // true
 * ```
 *
 * @param num - the {@link Number} to check
 * @returns `true` if the {@link Number} is greater than `0`, otherwise `false`
 */
export const isPositive: Predicate<[number]> = (num) => {
  return num > 0;
};