JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1005
  • Score
    100M100P100Q103459F
  • License MIT

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

Package Exports

  • is-index

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (is-index) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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 MAX_SAFE_INTEGER.

  • 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.