mirror of
https://github.com/whoisclebs/lodash.git
synced 2026-01-31 15:27:50 +00:00
37 lines
834 B
JavaScript
37 lines
834 B
JavaScript
import baseClamp from './.internal/baseClamp.js'
|
|
import toInteger from './toInteger.js'
|
|
|
|
/** Used as references for the maximum length and index of an array. */
|
|
const MAX_ARRAY_LENGTH = 4294967295
|
|
|
|
/**
|
|
* Converts `value` to an integer suitable for use as the length of an
|
|
* array-like object.
|
|
*
|
|
* **Note:** This method is based on
|
|
* [`ToLength`](http://ecma-international.org/ecma-262/7.0/#sec-tolength).
|
|
*
|
|
* @since 4.0.0
|
|
* @category Lang
|
|
* @param {*} value The value to convert.
|
|
* @returns {number} Returns the converted integer.
|
|
* @example
|
|
*
|
|
* toLength(3.2)
|
|
* // => 3
|
|
*
|
|
* toLength(Number.MIN_VALUE)
|
|
* // => 0
|
|
*
|
|
* toLength(Infinity)
|
|
* // => 4294967295
|
|
*
|
|
* toLength('3.2')
|
|
* // => 3
|
|
*/
|
|
function toLength(value) {
|
|
return value ? baseClamp(toInteger(value), 0, MAX_ARRAY_LENGTH) : 0
|
|
}
|
|
|
|
export default toLength
|