constant: floor
{
"comment": "/**\r\n * Computes `number` rounded down to `precision`.\r\n *\r\n * @since 3.10.0\r\n * @category Math\r\n * @param {number} number The number to round down.\r\n * @param {number} [precision=0] The precision to round down to.\r\n * @returns {number} Returns the rounded down number.\r\n * @example\r\n *\r\n * floor(4.006)\r\n * // => 4\r\n *\r\n * floor(0.046, 2)\r\n * // => 0.04\r\n *\r\n * floor(4060, -2)\r\n * // => 4000\r\n */",
"meta": {
"range": [
462,
490
],
"filename": "floor.js",
"lineno": 22,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\lodash\\lodash-repo",
"code": {
"id": "astnode100002780",
"name": "floor",
"type": "CallExpression",
"value": ""
}
},
"description": "Computes `number` rounded down to `precision`.",
"since": "3.10.0",
"tags": [
{
"originalTitle": "category",
"title": "category",
"text": "Math",
"value": "Math"
}
],
"params": [
{
"type": {
"names": [
"number"
]
},
"description": "The number to round down.",
"name": "number"
},
{
"type": {
"names": [
"number"
]
},
"optional": true,
"defaultvalue": 0,
"description": "The precision to round down to.",
"name": "precision"
}
],
"returns": [
{
"type": {
"names": [
"number"
]
},
"description": "Returns the rounded down number."
}
],
"examples": [
"floor(4.006)\r// => 4\r\rfloor(0.046, 2)\r// => 0.04\r\rfloor(4060, -2)\r// => 4000"
],
"name": "floor",
"longname": "floor",
"kind": "constant",
"scope": "global",
"___id": "T000002R000298",
"___s": true,
"filepath": "floor.js"
}