Skip to content

Commit fa99173

Browse files
committed
[doc] Fix nits
1 parent 0a61236 commit fa99173

File tree

3 files changed

+20
-15
lines changed

3 files changed

+20
-15
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -255,14 +255,13 @@ server.listen(8080);
255255
```js
256256
const http = require('http');
257257
const WebSocket = require('ws');
258-
const url = require('url');
259258

260259
const server = http.createServer();
261260
const wss = new WebSocket.Server({ noServer: true });
262261

263-
wss.on('connection', function(ws, request, client) {
264-
ws.on('message', function(message) {
265-
console.log(`WS message ${message} from user ${client}`);
262+
wss.on('connection', function connection(ws, request, client) {
263+
ws.on('message', function message(msg) {
264+
console.log(`Received message ${msg} from user ${client}`);
266265
});
267266
});
268267

@@ -272,6 +271,7 @@ server.on('upgrade', function upgrade(request, socket, head) {
272271
socket.destroy();
273272
return;
274273
}
274+
275275
wss.handleUpgrade(request, socket, head, function done(ws) {
276276
wss.emit('connection', ws, request, client);
277277
});
@@ -281,8 +281,7 @@ server.on('upgrade', function upgrade(request, socket, head) {
281281
server.listen(8080);
282282
```
283283

284-
Also see the provided [example](./examples/express-session-parse) using
285-
`express-session`.
284+
Also see the provided [example][session-parse-example] using `express-session`.
286285

287286
### Server broadcast
288287

@@ -477,14 +476,15 @@ We're using the GitHub [releases][changelog] for changelog entries.
477476

478477
[MIT](LICENSE)
479478

480-
[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent
481-
[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent
482-
[client-report]: http://websockets.github.io/ws/autobahn/clients/
483-
[server-report]: http://websockets.github.io/ws/autobahn/servers/
484-
[permessage-deflate]: https://tools.ietf.org/html/rfc7692
485479
[changelog]: https://github.com/websockets/ws/releases
480+
[client-report]: http://websockets.github.io/ws/autobahn/clients/
481+
[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent
486482
[node-zlib-bug]: https://github.com/nodejs/node/issues/8871
487483
[node-zlib-deflaterawdocs]:
488484
https://nodejs.org/api/zlib.html#zlib_zlib_createdeflateraw_options
485+
[permessage-deflate]: https://tools.ietf.org/html/rfc7692
486+
[server-report]: http://websockets.github.io/ws/autobahn/servers/
487+
[session-parse-example]: ./examples/express-session-parse
488+
[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent
489489
[ws-server-options]:
490490
https://github.com/websockets/ws/blob/master/doc/ws.md#new-websocketserveroptions-callback

examples/express-session-parse/index.js

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,20 @@ app.delete('/logout', function(request, response) {
4747
// Create HTTP server by ourselves.
4848
//
4949
const server = http.createServer(app);
50-
5150
const wss = new WebSocket.Server({ noServer: true });
5251

53-
server.on('upgrade', function upgrade(request, socket, head) {
52+
server.on('upgrade', function(request, socket, head) {
5453
console.log('Parsing session from request...');
54+
5555
sessionParser(request, {}, () => {
5656
if (!request.session.userId) {
5757
socket.destroy();
5858
return;
5959
}
60+
6061
console.log('Session is parsed!');
61-
wss.handleUpgrade(request, socket, head, function done(ws) {
62+
63+
wss.handleUpgrade(request, socket, head, function(ws) {
6264
wss.emit('connection', ws, request);
6365
});
6466
});
@@ -69,7 +71,9 @@ wss.on('connection', function(ws, request) {
6971
//
7072
// Here we can now use session parameters.
7173
//
72-
console.log(`WS message ${message} from user ${request.session.userId}`);
74+
console.log(
75+
`Received message ${message} from user ${request.session.userId}`
76+
);
7377
});
7478
});
7579

examples/express-session-parse/public/app.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
showMessage('No WebSocket connection');
6161
return;
6262
}
63+
6364
ws.send('Hello World!');
6465
showMessage('Sent "Hello World!"');
6566
};

0 commit comments

Comments
 (0)