dht-universal - npm Package Compare versions

Comparing version 0.1.1 to 0.2.0

esm/package.json

 {
   "type": "module",
   "browser": {
-    "./src/dht.js": "./src/relay.js"
+    "./src/dht.js": "./src/relay.js",
+    "./src/setup-relay.js": "./src/setup-relay.browser.js"
   }
 }

package.json

 {
   "name": "dht-universal",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Universal wrapper for @hyperswarm/dht and @hyperswarm/dht-relay working in Node.js and the Browser",
@@ -40,3 +40,6 @@ "keywords": [
     "./esm/src/dht.js": "./esm/src/relay.js",
-    "./cjs/src/dht.js": "./cjs/src/relay.js"
+    "./cjs/src/dht.js": "./cjs/src/relay.js",
+    "./relay.js": "./cjs/src/setup-relay.browser.js",
+    "./esm/src/setup-relay.js": "./esm/src/setup-relay.browser.js",
+    "./cjs/src/setup-relay.js": "./cjs/src/setup-relay.browser.js"
   },
@@ -49,3 +52,3 @@ "repository": {
     "build": "rm -rf dist && aegir build",
-    "test": "npm run test:dht && npm run test:relay",
+    "test": "npm run test:dht && npm run test:relay && npm run test:setup-relay",
     "test:dht": "aegir test -t node -f ./test/dht.spec.js",
@@ -55,2 +58,3 @@ "test:relay:node": "aegir test -t node -f ./test/relay.spec.js",
     "test:relay": "aegir test -f ./test/relay.spec.js",
+    "test:setup-relay": "aegir test -t node -f ./test/setup-relay.spec.js",
     "lint": "aegir ts -p check && aegir lint --fix",
@@ -87,4 +91,9 @@ "dep-check": "aegir dep-check",
       "import": "./esm/src/dht.js"
+    },
+    "./relay.js": {
+      "browser": "./esm/src/setup-relay.browser.js",
+      "require": "./cjs/src/setup-relay.js",
+      "import": "./esm/src/setup-relay.js"
     }
   }
 }

README.md

@@ -73,1 +73,11 @@ # dht-universal
 Other unit tests are available but might be removed later.
+
+## Setup Relay
+
+This module exposes a helper function to easily run a relay server.
+
+```js
+import { setupRelay } from 'dht-universal/setup-relay.js';
+
+const { port, closeRelay } = await setupRelay({ dhtOpts, port });
+```

No alert changes

Improved metrics

Total package byte prevSize

30688

increased by17.01%

Number of package files

30

increased by57.89%

Lines of code

351

increased by33.46%

Number of lines in readme file

83

increased by13.7%

No dependency changes