@bryopsida/eureka - npm Package Compare versions

Comparing version 0.2.0 to 0.4.0

package.json

 {
   "name": "@bryopsida/eureka",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "A library for securely discovering other processes in a multicast network",
@@ -13,3 +13,6 @@ "main": "lib.mjs",
     "lint": "standard .",
-    "lint:fix": "standard --fix ."
+    "lint:fix": "standard --fix .",
+    "build:docs": "jsdoc --configure jsdoc.json --destination docs --readme README.md --recurse src",
+    "prebuild:typings": "rm -rf *.d.mts && rm -fr src/*.d.mts",
+    "build:typings": "tsc --allowJs --declaration --emitDeclarationOnly --outDir . --target ESNext --module ESNext --strict --esModuleInterop --skipLibCheck lib.mjs src/crypto.mjs src/eureka.mjs src/header.mjs src/message-type.mjs src/transport.mjs"
   },
@@ -20,4 +23,5 @@ "author": "",
     "jsdoc": "^4.0.2",
-    "standard": "^17.1.0"
+    "standard": "^17.1.0",
+    "typescript": "^5.5.4"
   }
 }

README.md

@@ -18,2 +18,6 @@ # Eureka
 const id = randomUUID()
+const algorithm = 'aes-256-gcm' // or 'chacha20-poly1305'
+const kdfFunction = 'pbkdf2' // or 'scrypt'
+const chunkSize = 1500 // amount of data passed to send at one time including header, decrease if you encounter EMSGSIZE errors
+const chunkSpacing = 25 // milliseconds in between chunk send calls
 
@@ -24,3 +28,7 @@ const eureka = new Eureka({
         salt,
-        password
+        password,
+        algorithm,
+        kdfFunction,
+        chunkSize,
+        chunkSpacing
     },
@@ -57,1 +65,5 @@ messageData: {
 To provide security the messages are encrypted with `ChaCha20-poly1305` using the `IP:PORT` of the sender as the additional authentication data.
+
+# Hosted JSDoc page
+
+You can find a hosted JSDoc page of the latest release [here](https://bryopsida.github.io/eureka/)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

38513

increased by81.89%

Number of package files

15

increased by87.5%

Lines of code

785

increased by36.76%

Number of lines in readme file

67

increased by21.82%

Worsened metrics

Dev dependency count

3

increased by50%

No dependency changes