is-index

Checks if the given value is a valid array-like index.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
is-index
001.0.28 years ago8 years agoMinified + gzip package size for is-index in KB

Readme

is-index
Checks if the given value is a valid array-like index.

MIT License
build:? coverage:?

Install

$ npm install --save is-index 

Usage

For more use-cases see the tests

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

isIndex(1);        // => true
isIndex(1, 5);     // => true
isIndex('1');      // => true
isIndex('1', 5);   // => true
isIndex('1', '5'); // => true

isIndex();         // => false
isIndex(null);     // => false
isIndex(true);     // => false
isIndex({});       // => false
isIndex([]);       // => false

API

isIndex(value, length)

value - The value to check.
length - The upper bounds of a valid index. Default is MAXSAFEINTEGER.

Related

  • is-length - Checks if the given value is a valid array-like length.
  • to-length - Converts value to an integer suitable for use as the length of an array-like object.
  • drop-left - Creates a slice of array with n elements dropped from the beginning.
  • drop-right - Creates a slice of array with n elements dropped from the end.
  • pick-items - Randomly sampling some items from an array.
  • pick-item - Randomly sampling a item from an array.
  • shuffle-arr - Randomize the order of the elements in an array or array-like object.
  • is-array-like - Checks if the given value is an array or array-like object.

Contributing

Pull requests and stars are highly welcome.
For bugs and feature requests, please create an issue.