@libp2p/upnp-nat 1.0.13-fb7c51c3c → 1.0.14

package/README.md

@@ -1,3 +1,5 @@
+# @libp2p/upnp-nat
+
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
@@ -7,6 +9,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 The service exported by this module attempts to configure NAT hole punching
 via UPnP.
 
@@ -26,11 +43,11 @@ import { tcp } from '@libp2p/tcp'
 import { uPnPNAT } from '@libp2p/upnp-nat'
 
 const node = await createLibp2p({
-  addresses: [
+  addresses: {
     listen: [
       '/ip4/0.0.0.0/tcp/0'
     ]
-  ],
+  },
   transports: [
     tcp()
   ],

package/dist/src/index.d.ts

@@ -20,11 +20,11 @@
  * import { uPnPNAT } from '@libp2p/upnp-nat'
  *
  * const node = await createLibp2p({
- *   addresses: [
+ *   addresses: {
  *     listen: [
  *       '/ip4/0.0.0.0/tcp/0'
  *     ]
- *   ],
+ *   },
  *   transports: [
  *     tcp()
  *   ],

package/dist/src/index.js

@@ -20,11 +20,11 @@
  * import { uPnPNAT } from '@libp2p/upnp-nat'
  *
  * const node = await createLibp2p({
- *   addresses: [
+ *   addresses: {
  *     listen: [
  *       '/ip4/0.0.0.0/tcp/0'
  *     ]
- *   ],
+ *   },
  *   transports: [
  *     tcp()
  *   ],

package/dist/typedoc-urls.json

@@ -0,0 +1,10 @@
+{
+  "PMPOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_upnp_nat.PMPOptions.html",
+  ".:PMPOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_upnp_nat.PMPOptions.html",
+  "UPnPNATComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_upnp_nat.UPnPNATComponents.html",
+  ".:UPnPNATComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_upnp_nat.UPnPNATComponents.html",
+  "UPnPNATInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_upnp_nat.UPnPNATInit.html",
+  ".:UPnPNATInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_upnp_nat.UPnPNATInit.html",
+  "uPnPNAT": "https://libp2p.github.io/js-libp2p/functions/_libp2p_upnp_nat.uPnPNAT.html",
+  ".:uPnPNAT": "https://libp2p.github.io/js-libp2p/functions/_libp2p_upnp_nat.uPnPNAT.html"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/upnp-nat",
-  "version": "1.0.13-fb7c51c3c",
+  "version": "1.0.14",
   "description": "UPnP NAT hole punching",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/upnp-nat#readme",
@@ -43,6 +43,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build --no-bundle",
     "test": "aegir test -t node -t electron-main",
     "test:node": "aegir test -t node --cov",
@@ -50,16 +51,16 @@
   },
   "dependencies": {
     "@achingbrain/nat-port-mapper": "^1.0.13",
-    "@libp2p/interface": "1.1.3-fb7c51c3c",
-    "@libp2p/interface-internal": "1.0.8-fb7c51c3c",
-    "@libp2p/utils": "5.2.5-fb7c51c3c",
+    "@libp2p/interface": "^1.1.4",
+    "@libp2p/interface-internal": "^1.0.9",
+    "@libp2p/utils": "^5.2.6",
     "@multiformats/multiaddr": "^12.1.14",
     "wherearewe": "^2.0.1"
   },
   "devDependencies": {
-    "@libp2p/logger": "4.0.6-fb7c51c3c",
-    "@libp2p/peer-id-factory": "4.0.6-fb7c51c3c",
-    "aegir": "^42.2.3",
+    "@libp2p/logger": "^4.0.7",
+    "@libp2p/peer-id-factory": "^4.0.7",
+    "aegir": "^42.2.4",
     "sinon-ts": "^2.0.0"
   },
   "sideEffects": false

package/src/index.ts

@@ -20,11 +20,11 @@
  * import { uPnPNAT } from '@libp2p/upnp-nat'
  *
  * const node = await createLibp2p({
- *   addresses: [
+ *   addresses: {
  *     listen: [
  *       '/ip4/0.0.0.0/tcp/0'
  *     ]
- *   ],
+ *   },
  *   transports: [
  *     tcp()
  *   ],