# bupnp

> UPNP client for node.js

Latest version **0.2.6** (published 2019-03-21) · MIT license · 0 weekly downloads

## Install

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

## 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.2.6 |
| Published | 2019-03-21 |
| First published | 2017-11-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 3 |
| Unpacked size | 17.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Author | Christopher Jeffrey |
| Maintainers | chjj |
| Keywords | upnp |

## Links

- npm: https://www.npmjs.com/package/bupnp
- Repository: https://github.com/bcoin-org/bupnp
- Issues: https://github.com/bcoin-org/bupnp/issues
- npm.io page: https://npm.io/package/bupnp

## Dependencies (3)

- [brq](https://npm.io/package/brq.md) ~0.1.7
- [binet](https://npm.io/package/binet.md) ~0.3.5
- [bsert](https://npm.io/package/bsert.md) ~0.0.10

## Recent versions

- 0.2.6 (latest) — 2019-03-21
- 0.2.5 — 2019-01-22
- 0.2.4 — 2018-11-29
- 0.2.3 — 2018-09-29
- 0.2.2 — 2018-07-19
- 0.2.1 — 2018-06-09
- 0.2.0 — 2018-06-08
- 0.1.0 — 2018-04-06
- 0.0.2 — 2018-03-12
- 0.0.1 — 2017-12-29
- 0.0.0 — 2017-11-02

## README

# bupnp

UPNP for node.js.

## Usage

``` js
const UPNP = require('bupnp');
```

## API

```javascript
// Set a timeout
UPNP.RESPONSE_TIMEOUT = 1000

// Discovering internet gateway (upnp)
let wan = await UPNP.discover()

// Find external IP (upnp)
let host = await wan.getExternalIP()

// Add port mapping (remoteHost, externalPort, internalPort)
await wan.addPortMapping(host, src, dest)

// Remove port mapping
await wan.removePortMapping(host, port)
```


## Contribution and License Agreement

If you contribute code to this project, you are implicitly allowing your code
to be distributed under the MIT license. You are also implicitly verifying that
all code is your original work. `</legalese>`

## License

- Copyright (c) 2017, Christopher Jeffrey (MIT License).

See LICENSE for more info.

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