All files / number/src isZero.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
1x
 
 
 
 
 
 
 
 
 
 
 
 
 
3x
 
import { isFalsy } from "@benneq/object";
import { Predicate } from "@benneq/predicate";
 
/**
 * A {@link Predicate} that checks if a {@link Number} is zero.
 *
 * @example
 * Returns `true` if number is `=== 0`
 * ```ts
 * const result = isZero(0);
 *
 * console.log(result); // true
 * ```
 */
export const isZero: Predicate<[number]> = isFalsy;