lodash / lodash

Cannot retrieve contributors at this time

47 lines (45 sloc) 1.01 KB

Raw Blame

	import baseInRange from './.internal/baseInRange.js'

	/**
	* Checks if `number` is between `start` and up to, but not including, `end`. If
	* `end` is not specified, it's set to `start` with `start` then set to `0`.
	* If `start` is greater than `end` the params are swapped to support
	* negative ranges.
	*
	* @since 3.3.0
	* @category Number
	* @param {number} number The number to check.
	* @param {number} [start=0] The start of the range.
	* @param {number} end The end of the range.
	* @returns {boolean} Returns `true` if `number` is in the range, else `false`.
	* @see range, rangeRight
	* @example
	*
	* inRange(3, 2, 4)
	* // => true
	*
	* inRange(4, 8)
	* // => true
	*
	* inRange(4, 2)
	* // => false
	*
	* inRange(2, 2)
	* // => false
	*
	* inRange(1.2, 2)
	* // => true
	*
	* inRange(5.2, 4)
	* // => false
	*
	* inRange(-3, -2, -6)
	* // => true
	*/
	function inRange(number, start, end) {
	if (end === undefined) {
	end = start
	start = 0
	}
	return baseInRange(+number, +start, +end)
	}

	export default inRange

lodash/inRange.js / Jump to Code definitions inRange Function Code navigation index up-to-date