UNPKG

738 BJavaScriptView Raw
1'use strict';
2
3var handleCurry = require('./utils/handleCurry');
4
5/**
6 * Checks whether a value is greater than expected number
7 *
8 * **Aliases** _greater_, _gt_
9 * @function greaterThan
10 *
11 * @example
12 * var is = require('predicates');
13 *
14 * var isGreaterThan0 = is.greaterThan(0);
15 *
16 * isGreaterThan0(10); // true
17 * // same as
18 * is.greaterThan(0, 10); // true
19 * isGreaterThan0(-1); // false
20 *
21 * @param {Number} expected
22 * @param {Number} [value]
23 * @returns {(Boolean|Predicate)} bool if at least two arguments provided, otherwise a predicate
24 */
25module.exports = function isGreaterThan(expected) {
26 return handleCurry.call(this, arguments, function isGreaterThanPredicate(value) {
27 return value > expected;
28 });
29};