Skip to content

isLength

Checks whether a value is a valid array-like length: a non-negative safe integer (0 <= value <= Number.MAX_SAFE_INTEGER).

Available since v3.0.3

import { isLength } from '@helpers4/guard';
// or, from the all-in-one package (same code, one install):
import { isLength } from 'helpers4/guard';
isLength(value: unknown): value is number
ParameterTypeDescription
valueunknownThe value to check

value is number — true if value is a valid length

Validate an array-like length before indexing

Section titled “Validate an array-like length before indexing”

Guards against negative, fractional, or unsafe length values.

isLength(3)   // => true
isLength(-1)  // => false
isLength(1.5) // => false

View source on GitHub