es-toolkit/dist/compat/util/toLength.js

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

const require_toInteger = require("./toInteger.js");
const require_clamp = require("../math/clamp.js");
const require_MAX_ARRAY_LENGTH = require("../_internal/MAX_ARRAY_LENGTH.js");
//#region src/compat/util/toLength.ts
/**
* Converts the value to a valid index. A valid index is an integer that is greater than or equal to `0` and less than or equal to `2^32 - 1`.
*
* It converts the given value to an integer. If the value is less than `0`, it returns `0`. If the value exceeds `2^32 - 1`, it returns `2^32 - 1`. Values that cannot be converted to a number (such as `NaN` or non-numeric strings) return `0`.
*
* @param value - The value to convert to a valid index.
* @returns The converted value.
*
* @example
* toLength(3.2)  // => 3
* toLength(-1)   // => 0
* toLength(1.9)  // => 1
* toLength('42') // => 42
* toLength(null) // => 0
* toLength('a')  // => 0
*/
function toLength(value) {
	if (value == null) return 0;
	return require_clamp.clamp(require_toInteger.toInteger(value), 0, require_MAX_ARRAY_LENGTH.MAX_ARRAY_LENGTH);
}
//#endregion
exports.toLength = toLength;