All files / object/src isNullish.ts

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

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 343x 3x                                                         24x 29x    
import { isNull } from "./isNull";
import { isUndefined } from "./isUndefined";
import { Nullish } from "./_types";
 
/**
 * Checks if a `value` is {@link Falsy}
 *
 * The opposite of {@link isNotNullish}
 *
 * @example
 * ```
 * const result = isNullish(null);
 * console.log(result); // true
 * ```
 *
 * @example
 * ```
 * const result = isNullish(undefined);
 * console.log(result); // true
 * ```
 *
 * @example
 * ```
 * const result = isNullish(0);
 * console.log(result); // false
 * ```
 *
 * @param value - the value to check
 * @returns `true` if `value` is Falsy, otherwise `false`
 */
export const isNullish = (value: unknown): value is Nullish => {
  return isUndefined(value) || isNull(value);
};