From 33ec17590d15cc11934a38837abc7d7419ad12b7 Mon Sep 17 00:00:00 2001 From: Benjamin Gruenbaum Date: Sun, 24 Jan 2016 11:35:35 +0200 Subject: [PATCH] doc: check for errors in `listen` event In the docs we typically check for errors and surface them. This is IMO a good idea and good practice. This PR adds a check for errors in three places in the `net` docs where it was missing. PR-URL: https://github.com/nodejs/node/pull/4834 Reviewed-By: Roman Reiss Reviewd-By: Colin Ihrig --- doc/api/net.markdown | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/doc/api/net.markdown b/doc/api/net.markdown index c6cf897d53d4d8..e7c9e3022eee25 100644 --- a/doc/api/net.markdown +++ b/doc/api/net.markdown @@ -51,7 +51,8 @@ var server = net.createServer((socket) => { }); // grab a random port. -server.listen(() => { +server.listen((err) => { + if (err) throw err; address = server.address(); console.log('opened server on %j', address); }); @@ -528,7 +529,8 @@ Here is an example of a client of the previously described echo server: ```js const net = require('net'); -const client = net.connect({port: 8124}, () => { //'connect' listener +const client = net.connect({port: 8124}, () => { + // 'connect' listener console.log('connected to server!'); client.write('world!\r\n'); }); @@ -581,8 +583,8 @@ Here is an example of a client of the previously described echo server: ```js const net = require('net'); -const client = net.connect({port: 8124}, - () => { //'connect' listener +const client = net.connect({port: 8124}, () => { + //'connect' listener console.log('connected to server!'); client.write('world!\r\n'); }); @@ -649,7 +651,8 @@ on port 8124: ```js const net = require('net'); -const server = net.createServer((c) => { //'connection' listener +const server = net.createServer((c) => { + // 'connection' listener console.log('client connected'); c.on('end', () => { console.log('client disconnected'); @@ -657,7 +660,9 @@ const server = net.createServer((c) => { //'connection' listener c.write('hello\r\n'); c.pipe(c); }); -server.listen(8124, () => { //'listening' listener +server.listen(8124, (err) => { + // 'listening' listener + if (err) throw err; console.log('server bound'); }); ``` @@ -672,7 +677,10 @@ To listen on the socket `/tmp/echo.sock` the third line from the last would just be changed to ```js -server.listen('/tmp/echo.sock', () => { /* 'listening' listener*/ }) +server.listen('/tmp/echo.sock', (err) => { + // 'listening' listener + if (err) throw err; +}); ``` Use `nc` to connect to a UNIX domain socket server: