All files / object/src isNull.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                                        48x 51x    
/**
 * Checks if a `value` is `null`
 *
 * The opposite of {@link isNotNull}
 *
 * @example
 * ```
 * const result = isNull(null);
 * console.log(result); // true
 * ```
 *
 * @example
 * ```
 * const result = isNull(0);
 * console.log(result); // false
 * ```
 *
 * @param value - the value to check
 * @returns `true` if `value` is `null`, otherwise `false`
 */
export const isNull = (value: unknown): value is null => {
  return value === null;
};