All files / predicate/src alwaysFalse.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                                                        13x 11x    
/**
 * A {@link Predicate} that always returns `false`.
 *
 * Opposite of {@link alwaysTrue}.
 *
 * @remark
 * All arguments are ignored
 *
 * @example
 * Returns always `false`
 * ```ts
 * const result = alwaysFalse();
 * console.log(result); // false
 * ```
 *
 * @example
 * As default value for an optional Function argument
 * ```ts
 * function canParseBoolean(canParse: ((s: String) => boolean) = alwaysFalse) {
 *   return canParse("true");
 * }
 *
 * const result = canParseBoolean();
 * console.log(result); // false
 * ```
 *
 * @returns `false`
 */
export const alwaysFalse = (..._: unknown[]): false => {
  return false;
};