add tips for handling auth and add typings for ws

yjs · Mar 27, 2024 · 7945a5b · 7945a5b
1 parent af5c36d
commit 7945a5b
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 6 deletions.
diff --git a/bin/server.cjs b/bin/server.cjs
@@ -1,8 +1,5 @@
 #!/usr/bin/env node
 
-/**
- * @type {any}
- */
 const WebSocket = require('ws')
 const http = require('http')
 const number = require('lib0/number')
@@ -20,9 +17,9 @@ const server = http.createServer((_request, response) => {
 wss.on('connection', setupWSConnection)
 
 server.on('upgrade', (request, socket, head) => {
-  // You may check auth of request here.. Call `wss.HandleUpgrade` *after* you
-  // checked whether the client has access (e.g. by checking cookies, or url
-  // parameters).
+  // You may check auth of request here..
+  // Call `wss.HandleUpgrade` *after* you checked whether the client has access
+  // (e.g. by checking cookies, or url parameters).
   // See https://github.com/websockets/ws#client-authentication
   wss.handleUpgrade(request, socket, head, /** @param {any} ws */ ws => {
     wss.emit('connection', ws, request)

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -65,6 +65,7 @@
   },
   "devDependencies": {
     "@types/node": "^18.15.0",
+    "@types/ws": "^8.5.10",
     "rollup": "^3.19.1",
     "standard": "^12.0.1",
     "typescript": "^4.9.5",