# neighbour

> run "ip neigh show" in node and return parsed entities

Latest version **1.0.1** (published 2021-06-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install neighbour
pnpm add neighbour
yarn add neighbour
bun add neighbour
```

## 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.1 |
| Published | 2021-06-11 |
| First published | 2021-06-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Anthony Mugendi |
| Maintainers | nguru |
| Keywords | ip, neigh, neighbour, show, mac, address, connected, devices |

## Links

- npm: https://www.npmjs.com/package/neighbour
- Repository: https://github.com/mugendi/ip-neigh
- Homepage: https://github.com/mugendi/ip-neigh#readme
- Issues: https://github.com/mugendi/ip-neigh/issues
- npm.io page: https://npm.io/package/neighbour

## Dependencies (1)

- [ip-regex](https://npm.io/package/ip-regex.md) ^4.3.0

## Alternatives

- [adhdev](https://npm.io/package/adhdev.md) — 11.1K weekly downloads
- [react-slide-button](https://npm.io/package/react-slide-button.md) — 310 weekly downloads
- [better](https://npm.io/package/better.md) — 42 weekly downloads
- [react-native-swipe-image](https://npm.io/package/react-native-swipe-image.md) — 22 weekly downloads
- [nl.fokkezb.pulltorefresh](https://npm.io/package/nl.fokkezb.pulltorefresh.md) — 11 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-06-11
- 1.0.0 — 2021-06-11

## README

# What
Get the IPv4 neighbour table (also known as the ARP table) and display as json as shown below.

```json
[
  {
    "ip": "192.168.188.1",
    "interface": "wlp3s0",
    "mac": "74:f8:db:64:ca:a1",
    "state": "REACHABLE"
  }
]
```

## Usage

```javascript
// load module
let neigh = require("neighbour");

//async/await pattern
(async () => {
  let table = await neigh();
  console.log(table);
})();

//Or then/catch pattern
neigh()
  .then((table) => {
    console.log(table);
  })
  .catch(console.error);
```

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