@igosprojects/rivet-ws - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

README.md

+# rivet-ws
+
+rivet-ws is a plugin that implements WebSocket support for the Rivet library.
+
+# Usage
+
+To use the WS plugin you first need to initilize it by callling ```app.use```, and then you can register handlers on app.ws.
+```app.ws``` works the same way as ```app.get```, you can register handlers. Just like in this example:
+```ts
+import { Rivet } from "@igosprojects/rivet";
+import { WSPlugin } from "@igosprojects/rivet-ws"
+
+const app = new Rivet;
+
+app.use(WSPlugin);
+
+// /api will be where websocket is hosted 
+app.ws("/api", (req, res) => {
+    // This code runs when a client is connected
+    console.log("Client has been connected!");
+
+    // This code runs when "message" is recived
+    ws.on('message', (data) => {
+        const message = data.toString();
+        console.log(`Received: ${message}`); // Print the recived
+    });
+
+    // This code runs when the client disconnects and the socket closes
+    ws.on('close', () => {
+        console.log('Client disconnected');
+    });
+})
+
+app.get("/", (req, res) => {
+    res.send("");
+})
+
+app.start(8080, () => {
+    console.log("Started server! Go to localhost:8080");
+})
+```
+This library is very simple, and is not very complicated! It was made in like only a few hours lol

package.json

 {
   "name": "@igosprojects/rivet-ws",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "WebSocket plugin for @igosprojects/rivet",
@@ -5,0 +5,0 @@ "main": "index.js",

test/pnpm-lock.yaml

-lockfileVersion: '9.0'
-
-settings:
-  autoInstallPeers: true
-  excludeLinksFromLockfile: false
-
-importers:
-
-  .:
-    dependencies:
-      '@igosprojects/rivet':
-        specifier: ^1.0.6
-        version: 1.0.6
-
-packages:
-
-  '@igosprojects/rivet@1.0.6':
-    resolution: {integrity: sha512-LhkQRwKrSEOGvC5cd/LFmlKH1Gbz4J7nMD7qug+xzOavdiSfqxseRDRt1u4YnHApsB4XJDEQ/SRF/HSjSgivig==}
-
-snapshots:
-
-  '@igosprojects/rivet@1.0.6': {}

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Improved metrics

Total package byte prevSize

6623

14.8%

Number of medium quality alerts

0

-100%

Number of lines in readme file

42

Infinity%

No dependency changes