# win-arp

> Access the Windows ARP cache.

Latest version **0.1.0** (published 2016-09-18) · WTFPL license · 0 weekly downloads

## Install

```sh
npm install win-arp
pnpm add win-arp
yarn add win-arp
bun add win-arp
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2016-09-18 |
| First published | 2016-09-18 |
| Weekly downloads | 0 |
| License | WTFPL |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mark Tiedemann |
| Maintainers | marktiedemann |
| Keywords | win, windows, arp, address, resolution, cache |

## Links

- npm: https://www.npmjs.com/package/win-arp
- Repository: https://github.com/MarkTiedemann/win-arp
- Issues: https://github.com/MarkTiedemann/win-arp/issues
- npm.io page: https://npm.io/package/win-arp

## 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

- 0.1.0 (latest) — 2016-09-18

## README

# win-arp

**Access the [Windows ARP cache](https://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/arp.mspx).**

## Installation

```
npm install win-arp
```

## Quickstart

```js

// Get all dynamic ARP records found for the WiFi network interface

const arp = require('win-arp')({ iface: 'WiFi', type: 'dynamic' })
    .then(console.log)
    // => [ { ip: '192.168.0.21',
    //        mac: 'c5-0e-14-0d-2f-76',
    //        type: 'dynamic'
    //      }, ... ]

```

## API

### `require('win-arp')(options)`

- **options** `<Object>`
    - **iface** `<String>`: *default =* `WiFi`; the interface for which to retrieve arp records
    - **type** `<String>`: *default =* `dynamic|static`; the type of the records, one of `dynamic`, `static` or `dynamic|static`
- **throws** an `<Error>` if the interface cannot be found
- **returns** a `<Promise>` which:
    - resolves with **records** => `<Array>`: the arp records found
        - with each **record** being an `<Object>` with the following properties:
            - **ip** `<String>`: the IP address of the record
            - **mac** `<String>`: the MAC address of the record
            - **type** `<String>`: the type of the record, one of `dynamic` or `static`

## License

[WTFPL](http://www.wtfpl.net/) – Do What the F*ck You Want to Public License.

Made with :heart: by [@MarkTiedemann](https://twitter.com/MarkTiedemannDE).

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