Home

constant: rangeRight


  {
    "comment": "/**\r\n * This method is like `range` except that it populates values in\r\n * descending order.\r\n *\r\n * @since 4.0.0\r\n * @category Util\r\n * @param {number} [start=0] The start of the range.\r\n * @param {number} end The end of the range.\r\n * @param {number} [step=1] The value to increment or decrement by.\r\n * @returns {Array} Returns the range of numbers.\r\n * @see inRange, range\r\n * @example\r\n *\r\n * rangeRight(4)\r\n * // => [3, 2, 1, 0]\r\n *\r\n * rangeRight(-4)\r\n * // => [-3, -2, -1, 0]\r\n *\r\n * rangeRight(1, 5)\r\n * // => [4, 3, 2, 1]\r\n *\r\n * rangeRight(0, 20, 5)\r\n * // => [15, 10, 5, 0]\r\n *\r\n * rangeRight(0, -4, -1)\r\n * // => [-3, -2, -1, 0]\r\n *\r\n * rangeRight(1, 4, 0)\r\n * // => [1, 1, 1]\r\n *\r\n * rangeRight(0)\r\n * // => []\r\n */",
    "meta": {
        "range": [
            793,
            823
        ],
        "filename": "rangeRight.js",
        "lineno": 37,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\lodash\\lodash-repo",
        "code": {
            "id": "astnode100007498",
            "name": "rangeRight",
            "type": "CallExpression",
            "value": ""
        }
    },
    "description": "This method is like `range` except that it populates values in\rdescending order.",
    "since": "4.0.0",
    "tags": [
        {
            "originalTitle": "category",
            "title": "category",
            "text": "Util",
            "value": "Util"
        }
    ],
    "params": [
        {
            "type": {
                "names": [
                    "number"
                ]
            },
            "optional": true,
            "defaultvalue": 0,
            "description": "The start of the range.",
            "name": "start"
        },
        {
            "type": {
                "names": [
                    "number"
                ]
            },
            "description": "The end of the range.",
            "name": "end"
        },
        {
            "type": {
                "names": [
                    "number"
                ]
            },
            "optional": true,
            "defaultvalue": 1,
            "description": "The value to increment or decrement by.",
            "name": "step"
        }
    ],
    "returns": [
        {
            "type": {
                "names": [
                    "Array"
                ]
            },
            "description": "Returns the range of numbers."
        }
    ],
    "see": [
        "inRange, range"
    ],
    "examples": [
        "rangeRight(4)\r// => [3, 2, 1, 0]\r\rrangeRight(-4)\r// => [-3, -2, -1, 0]\r\rrangeRight(1, 5)\r// => [4, 3, 2, 1]\r\rrangeRight(0, 20, 5)\r// => [15, 10, 5, 0]\r\rrangeRight(0, -4, -1)\r// => [-3, -2, -1, 0]\r\rrangeRight(1, 4, 0)\r// => [1, 1, 1]\r\rrangeRight(0)\r// => []"
    ],
    "name": "rangeRight",
    "longname": "rangeRight",
    "kind": "constant",
    "scope": "global",
    "___id": "T000002R000686",
    "___s": true,
    "filepath": "rangeRight.js"
}