🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

is-index-x

Package Overview
Dependencies
Maintainers
1
Versions
23
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

is-index-x

Determine whether the passed value is a zero based index.

2.0.3
Source
npm
Version published
Weekly downloads
13K
-9.8%
Maintainers
1
Weekly downloads
 
Created
Source

Travis status Dependency status devDependency status npm version

is-index-x

Determine whether the passed value is a zero based index.

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.

ParamTypeDefaultDescription
valuenumber | stringThe value to be tested for being a zero based index.
[length]numberMAX_SAFE_INTEGERThe length that sets the upper bound.

Example

import isIndex from 'is-index-x';

console.log(isIndex(0)); // true
console.log(isIndex(1)); // true
console.log(isIndex('10')); // true

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

Keywords

number

FAQs

Package last updated on 16 Jul 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts