All files / object/src isFalsy.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 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38                                                                    13x 20x    
import { Falsy } from "./_types";
 
/**
 * Checks if a `value` is {@link Falsy}
 *
 * The opposite of {@link isTruthy}
 *
 * @example
 * ```
 * const result = isFalsy(0);
 * console.log(result); // true
 * ```
 *
 * @example
 * ```
 * const result = isFalsy(null);
 * console.log(result); // true
 * ```
 *
 * @example
 * ```
 * const result = isFalsy(1);
 * console.log(result); // false
 * ```
 *
 * @example
 * ```
 * const result = isFalsy(" ");
 * console.log(result); // false
 * ```
 *
 * @param value - the value to check
 * @returns `true` if `value` is Falsy, otherwise `false`
 */
export const isFalsy = (value: unknown): value is Falsy => {
  return !value;
};