Home

function: isBoolean

isBoolean(value: *): boolean

isBoolean.js, line 19

Checks if `value` is classified as a boolean primitive or object.

Example(s):

isBoolean(false)
// => true

isBoolean(null)
// => false

Params:

Name Type Attribute Description
value The value to check.

Returns:

boolean 

  {
    "comment": "/**\r\n * Checks if `value` is classified as a boolean primitive or object.\r\n *\r\n * @since 0.1.0\r\n * @category Lang\r\n * @param {*} value The value to check.\r\n * @returns {boolean} Returns `true` if `value` is a boolean, else `false`.\r\n * @example\r\n *\r\n * isBoolean(false)\r\n * // => true\r\n *\r\n * isBoolean(null)\r\n * // => false\r\n */",
    "meta": {
        "range": [
            431,
            578
        ],
        "filename": "isBoolean.js",
        "lineno": 19,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\lodash\\lodash-repo",
        "code": {
            "id": "astnode100004289",
            "name": "isBoolean",
            "type": "FunctionDeclaration",
            "paramnames": [
                "value"
            ]
        }
    },
    "description": "Checks if `value` is classified as a boolean primitive or object.",
    "since": "0.1.0",
    "tags": [
        {
            "originalTitle": "category",
            "title": "category",
            "text": "Lang",
            "value": "Lang"
        }
    ],
    "params": [
        {
            "type": {
                "names": [
                    "*"
                ]
            },
            "description": "The value to check.",
            "name": "value"
        }
    ],
    "returns": [
        {
            "type": {
                "names": [
                    "boolean"
                ]
            },
            "description": "Returns `true` if `value` is a boolean, else `false`."
        }
    ],
    "examples": [
        "isBoolean(false)\r// => true\r\risBoolean(null)\r// => false"
    ],
    "name": "isBoolean",
    "longname": "isBoolean",
    "kind": "function",
    "scope": "global",
    "___id": "T000002R000428",
    "___s": true,
    "filepath": "isBoolean.js"
}