# is-index

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

Latest version **1.0.2** (published 2016-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-index
pnpm add is-index
yarn add is-index
bun add is-index
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2016-04-15 |
| First published | 2016-04-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | bubkoo |
| Maintainers | bubkoo |
| Keywords | is, check, checks, detect, type, length, index, array, length-like, array-like, number, int, integer |

## Links

- npm: https://www.npmjs.com/package/is-index
- Repository: https://github.com/gearcase/is-index
- Homepage: https://github.com/gearcase/is-index#readme
- Issues: https://github.com/gearcase/is-index/issues
- npm.io page: https://npm.io/package/is-index

## Dependencies (1)

- [is-nil](https://npm.io/package/is-nil.md) ^1.0.0

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2016-04-15
- 1.0.1 — 2016-04-14
- 1.0.0 — 2016-04-13
- 0.0.0 — 2016-04-13

## README

# is-index

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

[![MIT License](https://img.shields.io/badge/license-MIT_License-green.svg?style=flat-square)](https://github.com/gearcase/is-index/blob/master/LICENSE)

[![build:?](https://img.shields.io/travis/gearcase/is-index/master.svg?style=flat-square)](https://travis-ci.org/gearcase/is-index)
[![coverage:?](https://img.shields.io/coveralls/gearcase/is-index/master.svg?style=flat-square)](https://coveralls.io/github/gearcase/is-index)


## Install

```
$ npm install --save is-index 
```


## Usage

> For more use-cases see the [tests](https://github.com/gearcase/is-index/blob/master/test/spec/index.js)

```js
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.

## Related

- [is-length](https://github.com/gearcase/is-length) - Checks if the given value is a valid array-like length.
- [to-length](https://github.com/gearcase/to-length) - Converts value to an integer suitable for use as the length of an array-like object.
- [drop-left](https://github.com/gearcase/drop-left) - Creates a slice of array with n elements dropped from the beginning.
- [drop-right](https://github.com/gearcase/drop-right) - Creates a slice of array with n elements dropped from the end.
- [pick-items](https://github.com/mock-end/pick-items) - Randomly sampling some items from an array. 
- [pick-item](https://github.com/mock-end/pick-item) - Randomly sampling a item from an array.
- [shuffle-arr](https://github.com/mock-end/shuffle-arr) - Randomize the order of the elements in an array or array-like object. 
- [is-array-like](https://github.com/gearcase/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](https://github.com/gearcase/is-index/issues/new).

---
_Source: https://npm.io/package/is-index · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._