{"_id":"@motrix/nat-api","_rev":"4647310","name":"@motrix/nat-api","description":"Port mapping with UPnP and NAT-PMP","dist-tags":{"latest":"0.3.4"},"maintainers":[{"name":"agalwood","email":"agalwood.net@gmail.com"}],"time":{"modified":"2026-04-10T20:21:59.000Z","created":"2020-05-28T02:36:19.647Z","0.3.4":"2023-04-13T06:30:40.421Z","0.3.3":"2023-03-29T13:09:40.201Z","0.3.2":"2021-06-16T11:59:25.817Z","0.3.1":"2020-05-28T02:36:19.647Z"},"users":{},"author":{"name":"Alex","email":"alxmorais8@msn.com"},"repository":{"type":"git","url":"git+https://github.com/alxhotel/nat-api.git"},"versions":{"0.3.4":{"version":"0.3.4","name":"@motrix/nat-api","description":"Port mapping with UPnP and NAT-PMP","main":"index.js","scripts":{"test":"standard"},"engines":{"node":">=10.0.0"},"dependencies":{"async":"^3.2.4","debug":"^4.3.4","default-gateway":"^6.0.3","node-fetch":"^2.6.9","unordered-array-remove":"^1.0.2","xml2js":"^0.5.0"},"devDependencies":{"standard":"^17.0.0"},"author":{"name":"Alex","email":"alxmorais8@msn.com"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/alxhotel/nat-api.git"},"bugs":{"url":"https://github.com/alxhotel/nat-api/issues"},"homepage":"https://github.com/alxhotel/nat-api#readme","keywords":["nat","api","upnp","pmp","nat-pmp","holepunch","port","forwarding","map","mapping"],"gitHead":"70a33f8790420189d0a90e695818bff8fa2ab0dd","_id":"@motrix/nat-api@0.3.4","_nodeVersion":"18.15.0","_npmVersion":"9.5.0","dist":{"shasum":"8c96bf64edf09f237caac6aaab39fbc823fdc4fa","size":11574,"noattachment":false,"key":"/@motrix/nat-api/-/@motrix/nat-api-0.3.4.tgz","tarball":"http://registry.cnpm.dingdandao.com/@motrix/nat-api/download/@motrix/nat-api-0.3.4.tgz"},"_npmUser":{"name":"agalwood","email":"agalwood.net@gmail.com"},"directories":{},"maintainers":[{"name":"agalwood","email":"agalwood.net@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nat-api_0.3.4_1681367440214_0.877450950054032"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2023-04-13T06:30:40.421Z","publish_time":1681367440421,"_cnpm_publish_time":1681367440421},"0.3.3":{"version":"0.3.3","name":"@motrix/nat-api","description":"Port mapping with UPnP and NAT-PMP","main":"index.js","scripts":{"test":"standard"},"engines":{"node":">=10.0.0"},"dependencies":{"async":"^3.2.4","debug":"^4.3.4","default-gateway":"^6.0.3","node-fetch":"^2.6.9","unordered-array-remove":"^1.0.2","xml2js":"^0.4.23"},"devDependencies":{"standard":"^17.0.0"},"author":{"name":"Alex","email":"alxmorais8@msn.com"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/alxhotel/nat-api.git"},"bugs":{"url":"https://github.com/alxhotel/nat-api/issues"},"homepage":"https://github.com/alxhotel/nat-api#readme","keywords":["nat","api","upnp","pmp","nat-pmp","holepunch","port","forwarding","map","mapping"],"gitHead":"1b6547fca5ed1047701cb8827ec0fcbc1350c729","_id":"@motrix/nat-api@0.3.3","_nodeVersion":"18.15.0","_npmVersion":"9.5.0","dist":{"shasum":"31ac9ca24dd3d8c6e75734e18ae3595431f86c31","size":11582,"noattachment":false,"key":"/@motrix/nat-api/-/@motrix/nat-api-0.3.3.tgz","tarball":"http://registry.cnpm.dingdandao.com/@motrix/nat-api/download/@motrix/nat-api-0.3.3.tgz"},"_npmUser":{"name":"agalwood","email":"agalwood.net@gmail.com"},"directories":{},"maintainers":[{"name":"agalwood","email":"agalwood.net@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nat-api_0.3.3_1680095380019_0.48799024447176653"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2023-03-29T13:09:40.201Z","publish_time":1680095380201,"_cnpm_publish_time":1680095380201},"0.3.2":{"version":"0.3.2","name":"@motrix/nat-api","description":"Port mapping with UPnP and NAT-PMP","main":"index.js","scripts":{"test":"standard"},"engines":{"node":">=10.0.0"},"dependencies":{"async":"^3.2.0","debug":"^4.3.1","default-gateway":"^6.0.3","request":"^2.88.2","unordered-array-remove":"^1.0.2","xml2js":"^0.4.23"},"devDependencies":{"standard":"^16.0.0"},"author":{"name":"Alex","email":"alxmorais8@msn.com"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/alxhotel/nat-api.git"},"bugs":{"url":"https://github.com/alxhotel/nat-api/issues"},"homepage":"https://github.com/alxhotel/nat-api#readme","keywords":["nat","api","upnp","pmp","nat-pmp","holepunch","port","forwarding","map","mapping"],"gitHead":"6e5613834b46e460c7a37694bc9c2c8e71648051","_id":"@motrix/nat-api@0.3.2","_nodeVersion":"12.18.0","_npmVersion":"6.14.4","dist":{"shasum":"a1164e25b1401279e2170666b0df3455812e7e1e","size":11440,"noattachment":false,"key":"/@motrix/nat-api/-/@motrix/nat-api-0.3.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/@motrix/nat-api/download/@motrix/nat-api-0.3.2.tgz"},"_npmUser":{"name":"agalwood","email":"agalwood.net@gmail.com"},"directories":{},"maintainers":[{"name":"agalwood","email":"agalwood.net@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nat-api_0.3.2_1623844765705_0.9773668890789582"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2021-12-25T00:37:06.930Z","publish_time":1623844765817,"_cnpm_publish_time":1623844765817},"0.3.1":{"version":"0.3.1","name":"@motrix/nat-api","description":"Port mapping with UPnP and NAT-PMP","main":"index.js","scripts":{"test":"standard"},"engines":{"node":">=10.0.0"},"dependencies":{"async":"^3.2.0","debug":"^4.1.1","default-gateway":"^6.0.1","request":"^2.88.2","unordered-array-remove":"^1.0.2","xml2js":"^0.4.23"},"devDependencies":{"standard":"^14.3.4"},"author":{"name":"Alex","email":"alxmorais8@msn.com"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/alxhotel/nat-api.git"},"bugs":{"url":"https://github.com/alxhotel/nat-api/issues"},"homepage":"https://github.com/alxhotel/nat-api#readme","keywords":["nat","api","upnp","pmp","nat-pmp","holepunch","port","forwarding","map","mapping"],"gitHead":"cdbe332bee20d6cb4abd38c150514ee4116d1e22","_id":"@motrix/nat-api@0.3.1","_nodeVersion":"12.16.3","_npmVersion":"6.14.5","dist":{"shasum":"de18e7101cc6ed82e9e1e7b5720cb2b40f490246","size":11336,"noattachment":false,"key":"/@motrix/nat-api/-/@motrix/nat-api-0.3.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/@motrix/nat-api/download/@motrix/nat-api-0.3.1.tgz"},"maintainers":[{"name":"agalwood","email":"agalwood.net@gmail.com"}],"_npmUser":{"name":"agalwood","email":"agalwood.net@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nat-api_0.3.1_1590633379543_0.3871772224134342"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2021-12-25T00:37:06.060Z","publish_time":1590633379647,"_cnpm_publish_time":1590633379647}},"readme":"# nat-api\n\n[![NPM Version][nat-api-ni]][nat-api-nu]\n[![Build Status][nat-api-bi]][nat-api-bu]\n[![Dependency Status][nat-api-di]][nat-api-du]\n[![Standard - Javascript Style Guide][standard-image]][standard-url]\n\nFast port mapping with **UPnP** and **NAT-PMP** in NodeJS.\n\n## Install\n\n**Required: NodeJS >= 10**\n\n```sh\nnpm install nat-api\n```\n\n## Usage\n\n```js\nconst NatAPI = require('nat-api')\n\nconst client = new NatAPI()\n\n// Map public port 1000 to private port 1000 with UDP and TCP\nclient.map(1000, function (err) {\n  if (err) return console.log('Error', err)\n  console.log('Port mapped!')\n})\n\n// Map public port 2000 to private port 3000 with UDP and TCP\nclient.map(2000, 3000, function (err) {\n  if (err) return console.log('Error', err)\n  console.log('Port mapped!')\n})\n\n// Map public port 4000 to private port 5000 with only UDP\nclient.map({ publicPort: 4000, privatePort: 5000, ttl: 1800, protocol: 'UDP' }, function (err) {\n  if (err) return console.log('Error', err)\n  console.log('Port mapped!')\n})\n\n// Unmap port public and private port 1000 with UDP and TCP\nclient.unmap(1000, function (err) {\n  if (err) return console.log('Error', err)\n  console.log('Port unmapped!') \n})\n\n// Get external IP\nclient.externalIp(function(err, ip) {\n  if (err) return console.log('Error', err)\n  console.log('External IP:', ip)\n})\n\n// Destroy object\nclient.destroy()\n```\n\n## API\n\n### `client = new NatAPI([opts])`\n\nCreate a new `nat-api` instance.\n\nIf `opts` is specified, then the default options (shown below) will be overridden.\n\n```js\n{\n  ttl: 1200, // Time to live of each port mapping in seconds (default: 1200)\n  autoUpdate: true, // Refresh all the port mapping to keep them from expiring (default: true)\n  gateway: '192.168.1.1', // Default gateway (default: null)\n  enablePMP: false // Enable PMP (default: false)\n}\n```\n\nIf `gateway` is not set, then `nat-api` will get the default gateway based on the current network interface.\n\n### `client.map(port, [callback])`\n* `port`: Public and private ports\n* `callback`\n\nThis method will use `port` por mapping the public port to the same private port.\n\nIt uses the default TTL and creates a map for UDP and TCP.\n\n### `client.map(publicPort, privatePort, [callback])`\n* `publicPort`: Public port\n* `privatePort`: Private port\n* `callback`\n\nThis is another quick way of mapping `publciPort` to `privatePort` with any protocol (UDP and TCP).\n\n### `client.map(opts, [callback])`\n* `opts`:\n - `publicPort`: Public port\n - `privatePort`: Private port\n - `protocol`: Port protocol (`UDP`, `TCP` or `null` for both)\n - `ttl`: Overwrite the default TTL in seconds.\n - `description`: Description of the port mapping\n* `callback`\n\n### `client.unmap(port, [callback])`\n\nUnmap any port that has the public port or private port equal to `port`.\n\n### `client.unmap(publicPort, privatePort, [callback])`\n\nUnmap any port that has the public port or private port equal to `publicPort` and `privatePort`, respectively.\n\n### `client.unmap(opts, [callback])`\n\nUnmap any port that contains the parameters provided in `opts`.\n\n### `client.externalIp([callback])`\n* `callback(err, ip)`\n\nGet the external IP address.\n\n### `client.destroy([callback])`\n\nDestroy the client. Unmaps all the ports open with `nat-api` and cleans up large data structure resources.\n\n## Additional Information\n\n- http://miniupnp.free.fr/nat-pmp.html\n- http://wikipedia.org/wiki/NAT_Port_Mapping_Protocol\n- http://tools.ietf.org/html/draft-cheshire-nat-pmp-03\n\n\n## License\n\nMIT. Copyright (c) [Alex](https://github.com/alxhotel)\n\n[nat-api-ni]: https://img.shields.io/npm/v/nat-api.svg\n[nat-api-nu]: https://npmjs.org/package/nat-api\n[nat-api-bi]: https://img.shields.io/github/workflow/status/alxhotel/nat-api/ci/master\n[nat-api-bu]: https://github.com/alxhotel/nat-api/actions\n[nat-api-di]: https://img.shields.io/librariesio/release/npm/nat-api\n[nat-api-du]: https://libraries.io/npm/nat-api\n[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg\n[standard-url]: https://standardjs.com\n","_attachments":{},"homepage":"https://github.com/alxhotel/nat-api#readme","bugs":{"url":"https://github.com/alxhotel/nat-api/issues"},"license":"MIT"}