# error-if-index-not-valid

> Function triggers error if a given index cannot exist in a given array length

Latest version **2.0.0** (published 2020-07-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install error-if-index-not-valid
pnpm add error-if-index-not-valid
yarn add error-if-index-not-valid
bun add error-if-index-not-valid
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-07-30 |
| First published | 2019-03-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Steve Thompson |
| Maintainers | writetome51 |
| Keywords | array, index, validation, checking, error, message |

## Links

- npm: https://www.npmjs.com/package/error-if-index-not-valid
- Repository: https://github.com/writetome51/error-if-index-not-valid
- Homepage: https://github.com/writetome51/error-if-index-not-valid#readme
- Issues: https://github.com/writetome51/error-if-index-not-valid/issues
- npm.io page: https://npm.io/package/error-if-index-not-valid

## Dependencies (1)

- [@writetome51/index-is-valid](https://npm.io/package/@writetome51/index-is-valid.md) ^2.0.0

## Recent versions

- 2.0.0 (latest) — 2020-07-30
- 1.0.0 — 2019-03-30

## README

# errorIfIndexNotValid(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;index,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;arrayLength<br>): void

Triggers error if `index` cannot exist in `arrayLength`.  
`index` is allowed to be negative.

## Examples
```
errorIfIndexNotValid(1, 2); // No error.

errorIfIndexNotValid(2, 2);
// "Error:  The entered index is not valid.  Whether positive or negative,
// it exceeds the index range of the array."

errorIfIndexNotValid(-2, 2); // No error.

errorIfIndexNotValid(-3, 2);
// "Error:  The entered index is not valid.  Whether positive or negative,
// it exceeds the index range of the array."

errorIfIndexNotValid(1, 1);
// "Error:  The entered index is not valid.  Whether positive or negative,
// it exceeds the index range of the array."
```

## Installation
`npm i  error-if-index-not-valid`

## Loading
```js
import { errorIfIndexNotValid } from 'error-if-index-not-valid';
```

## License
[MIT](https://choosealicense.com/licenses/mit/)

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