@writetome51/array-get-adjacent-at
Version:
Returns chosen number of adjacent items in array beginning at chosen index
32 lines (23 loc) • 968 B
Markdown
# getAdjacentAt\<T\>(<br> startingIndex: number,<br> howMany: number,<br> array: T[]<br>): T[]
Beginning at `startingIndex`, returns `howMany` adjacent items from `array`.
Does not modify `array`. `startingIndex` can be negative or positive.
Intended as a replacement of Array.prototype.slice() . It strictly validates args.
## Examples
```js
let arr = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
getAdjacentAt(0, 3, arr);
// --> [1,2,3]
getAdjacentAt(2, 5, arr);
// --> [3,4,5,6,7]
// You can pass a negative index:
getAdjacentAt(-3, 2, arr);
// --> [8, 9]
getAdjacentAt(-2, 3, arr); // Requesting one too may items
//Error: 'the array does not have enough items to fulfill your request'
```
## Installation
`npm i @writetome51/array-get-adjacent-at`
## Loading
```js
import { getAdjacentAt } from '@writetome51/array-get-adjacent-at';
```