is-index-x

is-index-x

Determine whether the passed value is a zero based index.

Version: 1.1.0
Author: Xotic750 [e-mail]
License: MIT
Copyright: Xotic750

module.exports(value, [length]) ⇒ boolean ⏏

This method determines whether the passed value is a zero based index. JavaScript arrays are zero-indexed: the first element of an array is at index 0, and the last element is at the index equal to the value of the array's length property minus 1.

Kind: Exported function
Returns: boolean - A Boolean indicating whether or not the given value is a zero based index within bounds.

Param	Type	Default	Description
value	number | string		The value to be tested for being a zero based index.
[length]	number	MAX_SAFE_INTEGER	The length that sets the upper bound.

Example

var isIndex = require('is-index-x');

isIndex(0);                    // true
isIndex(1);                    // true
isIndex('10');                 // true

isIndex(-100000);              // false
isIndex(Math.pow(2, 53));      // false
isIndex(0.1);                  // false
isIndex(Math.PI);              // false
isIndex(NaN);                  // false
isIndex(Infinity);             // false
isIndex(-Infinity);            // false
isIndex(true);                 // false
isIndex(false);                // false
isIndex([1]);                  // false
isIndex(10, 10);               // false