Home

function: gte

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

gte.js, line 22

Checks if `value` is greater than or equal to `other`.

Example(s):

gte(3, 1)
// => true

gte(3, 3)
// => true

gte(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 or equal to `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 or equal to\r\n *  `other`, else `false`.\r\n * @see gt, lt, lte\r\n * @example\r\n *\r\n * gte(3, 1)\r\n * // => true\r\n *\r\n * gte(3, 3)\r\n * // => true\r\n *\r\n * gte(1, 3)\r\n * // => false\r\n */",
    "meta": {
        "range": [
            440,
            607
        ],
        "filename": "gte.js",
        "lineno": 22,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\lodash\\lodash-repo",
        "code": {
            "id": "astnode100003239",
            "name": "gte",
            "type": "FunctionDeclaration",
            "paramnames": [
                "value",
                "other"
            ]
        },
        "vars": {
            "value": "gte~value",
            "other": "gte~other"
        }
    },
    "description": "Checks if `value` is greater than or equal to `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 or equal to\r `other`, else `false`."
        }
    ],
    "see": [
        "gt, lt, lte"
    ],
    "examples": [
        "gte(3, 1)\r// => true\r\rgte(3, 3)\r// => true\r\rgte(1, 3)\r// => false"
    ],
    "name": "gte",
    "longname": "gte",
    "kind": "function",
    "scope": "global",
    "___id": "T000002R000341",
    "___s": true,
    "filepath": "gte.js"
}