# @writetome51/array-get-adjacent-to-value

> Returns array of adjacent items from passed array, starting with, or close to, the passed value

Latest version **1.0.5** (published 2019-04-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @writetome51/array-get-adjacent-to-value
pnpm add @writetome51/array-get-adjacent-to-value
yarn add @writetome51/array-get-adjacent-to-value
bun add @writetome51/array-get-adjacent-to-value
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2019-04-11 |
| First published | 2018-10-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 14.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Steve Thompson |
| Maintainers | writetome51 |
| Keywords | array, manipulation |

## Links

- npm: https://www.npmjs.com/package/@writetome51/array-get-adjacent-to-value
- Homepage: https://github.com/writetome51/array-get-adjacent-to-value#readme
- npm.io page: https://npm.io/package/@writetome51/array-get-adjacent-to-value

## Dependencies (6)

- [error-if-not-integer](https://npm.io/package/error-if-not-integer.md) ~1.0.0
- [error-if-index-is-negative](https://npm.io/package/error-if-index-is-negative.md) ~1.0.1
- [@writetome51/array-get-indexes](https://npm.io/package/@writetome51/array-get-indexes.md) ~1.0.2
- [@writetome51/array-get-adjacent-at](https://npm.io/package/@writetome51/array-get-adjacent-at.md) ~1.0.4
- [@writetome51/adjacent-to-value-info-interface](https://npm.io/package/@writetome51/adjacent-to-value-info-interface.md) ~1.0.2
- [error-if-index-not-valid-after-offset-was-added](https://npm.io/package/error-if-index-not-valid-after-offset-was-added.md) ~1.0.0

## Recent versions

- 1.0.5 (latest) — 2019-04-11
- 1.0.4 — 2019-04-01
- 1.0.3 — 2019-02-26
- 1.0.2 — 2018-12-07
- 1.0.1 — 2018-10-25
- 1.0.0 — 2018-10-16

## README

## getAdjacentToValue(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value: anyExceptObject,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;offset: integer,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;howMany: integer_greater_than_zero<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;array<br>): any[]

Returns `howMany` adjacent items from `array`, starting with, or close to, `value`.  
Exactly where the selection starts is decided by `offset`, which is the position,  
relative to `value`, where to begin the selection. For example, if `offset` is 0,  
then the selection begins at `value`. If -1, it begins one place to the left of  
`value`. If 1, it begins one place to the right.

`array` is not modified.

Note: the function only works with the first found instance of `value`.


### Examples
```
let array = [1,3,5,7,9,11,13,15,17];

getAdjacentToValue({value: 7, offset: 0, howMany: 3},  array);
// --> [7, 9, 11]

getAdjacentToValue({value: 7, offset: 2, howMany: 3},  array);
// --> [11, 13, 15]

array = [1, 3, ['hello','goodbye'], 15, 17];

getAdjacentToValue(
    {value: ['hello','goodbye'], offset: -1, howMany: 2},  
    array
);
// --> [ 3, ['hello','goodbye'] ]
```

### Installation
`npm i @writetome51/array-get-adjacent-to-value`

### Loading
```
// if using Typescript:
import {getAdjacentToValue} from '@writetome51/array-get-adjacent-to-value';
// if using ES5 Javascript:
var getAdjacentToValue = 
    require('@writetome51/array-get-adjacent-to-value').getAdjacentToValue;
```

---
_Source: https://npm.io/package/@writetome51/array-get-adjacent-to-value · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._