Home

function: gt

gt(value: *, other: *): boolean

gt.js, line 22

Checks if `value` is greater than `other`.

Example(s):

gt(3, 1)
// => true

gt(3, 3)
// => false

gt(1, 3)
// => false

Params:

Name Type Attribute Description
value The value to compare.
other The other value to compare.

Returns:

boolean 

  {
    "comment": "/**\r\n * Checks if `value` is greater than `other`.\r\n *\r\n * @since 3.9.0\r\n * @category Lang\r\n * @param {*} value The value to compare.\r\n * @param {*} other The other value to compare.\r\n * @returns {boolean} Returns `true` if `value` is greater than `other`,\r\n *  else `false`.\r\n * @see gte, lt, lte\r\n * @example\r\n *\r\n * gt(3, 1)\r\n * // => true\r\n *\r\n * gt(3, 3)\r\n * // => false\r\n *\r\n * gt(1, 3)\r\n * // => false\r\n */",
    "meta": {
        "range": [
            415,
            580
        ],
        "filename": "gt.js",
        "lineno": 22,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\lodash\\lodash-repo",
        "code": {
            "id": "astnode100003205",
            "name": "gt",
            "type": "FunctionDeclaration",
            "paramnames": [
                "value",
                "other"
            ]
        },
        "vars": {
            "value": "gt~value",
            "other": "gt~other"
        }
    },
    "description": "Checks if `value` is greater than `other`.",
    "since": "3.9.0",
    "tags": [
        {
            "originalTitle": "category",
            "title": "category",
            "text": "Lang",
            "value": "Lang"
        }
    ],
    "params": [
        {
            "type": {
                "names": [
                    "*"
                ]
            },
            "description": "The value to compare.",
            "name": "value"
        },
        {
            "type": {
                "names": [
                    "*"
                ]
            },
            "description": "The other value to compare.",
            "name": "other"
        }
    ],
    "returns": [
        {
            "type": {
                "names": [
                    "boolean"
                ]
            },
            "description": "Returns `true` if `value` is greater than `other`,\r else `false`."
        }
    ],
    "see": [
        "gte, lt, lte"
    ],
    "examples": [
        "gt(3, 1)\r// => true\r\rgt(3, 3)\r// => false\r\rgt(1, 3)\r// => false"
    ],
    "name": "gt",
    "longname": "gt",
    "kind": "function",
    "scope": "global",
    "___id": "T000002R000337",
    "___s": true,
    "filepath": "gt.js"
}