npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@silentbot1/nat-api

v0.4.7

Published

Port mapping with UPnP and NAT-PMP

Downloads

19,659

Readme

nat-api

NPM Version Build Status Dependency Status Standard - Javascript Style Guide

Fast port mapping with UPnP and NAT-PMP in NodeJS.

Install

Required: NodeJS >= 10

npm install @silentbot1/nat-api

Usage

const NatAPI = require('nat-api')

// For NAT-PMP + NAT-UPNP, use:
const client = new NatAPI({ enablePMP: true, enableUPNP: true })

// Note: upnpPermanentFallback is disabled by default, meaning leases on routers which only support UPnP permanent leases will fail, this includes RouterOS/Mikrotik, Netgear, and other ISP provided routers. 

// Map public port 1000 to private port 1000 with UDP and TCP
client.map(1000).then(() => {
  console.log('Port mapped!')
}).catch((err) => {
  return console.log('Error', err)
})

// Map public port 2000 to private port 3000 with UDP and TCP
client.map(2000, 3000).then(() => {
  console.log('Port mapped!')
}).catch((err) => {
  return console.log('Error', err)
})

// Map public port 4000 to private port 5000 with only UDP
client.map({ publicPort: 4000, privatePort: 5000, ttl: 1800, protocol: 'UDP' }).then(() => {
  console.log('Port mapped!')
}).catch((err) =>{
  return console.log('Error', err)
})

// Unmap port public and private port 1000 with UDP and TCP
client.unmap(1000).then(() => {
  console.log('Port unmapped!') 
}).catch((err) => {
  return console.log('Error', err)
})

// Get external IP
client.externalIp().then((ip) => {
  console.log('External IP:', ip)
}).catch((err) => {
  return console.log('Error', err)
})

// Destroy object
client.destroy().then(() => {
  console.log('Client has been destroyed!')
}).catch((err) => {
  return console.log('Error', err)
})

API

client = new NatAPI([opts])

Create a new nat-api instance.

If opts is specified, then the default options (shown below) will be overridden.

{
  ttl: 1200, // Time to live of each port mapping in seconds (default: 1200)
  autoUpdate: true, // Refresh all the port mapping to keep them from expiring (default: true)
  gateway: '192.168.1.1', // Default gateway (default: null)
  enablePMP: false, // Enable PMP (default: true)
  enableUPNP: false, // Enable UPNP (default: true)
  upnpPermanentFallback: false // Enable UPNP permanent leases fallback (default: false)
}

If gateway is not set, then nat-api will get the default gateway based on the current network interface.

client.map(port): Promise<void>

  • port: Public and private ports

This method will use port for mapping the public port to the same private port.

It uses the default TTL and creates a map for UDP and TCP.

client.map(publicPort, privatePort): Promise<void>

  • publicPort: Public port
  • privatePort: Private port

This is another quick way of mapping publciPort to privatePort for both UDP and TCP.

client.map(opts): Promise<void>

  • opts:
  • publicPort: Public port
  • privatePort: Private port
  • protocol: Port protocol (UDP, TCP or null for both)
  • ttl: Overwrite the default TTL in seconds.
  • description: Description of the port mapping

client.unmap(port): Promise<void>

Unmap any port that has the public port or private port equal to port.

client.unmap(publicPort, privatePort): Promise<void>

Unmap any port that has the public port or private port equal to publicPort and privatePort, respectively.

client.unmap(opts): Promise<void>

Unmap any port that contains the parameters provided in opts.

client.externalIp(): Promise<string>

Get the external IP address.

client.destroy(): Promise<void>

Destroy the client. Unmaps all the ports open with nat-api and cleans up large data structure resources.

Additional Information

  • http://miniupnp.free.fr/nat-pmp.html
  • http://wikipedia.org/wiki/NAT_Port_Mapping_Protocol
  • http://tools.ietf.org/html/draft-cheshire-nat-pmp-03

License

MIT. Copyright (c) Brad Marsden