doc: check for errors in 'listen' event
authorBenjamin Gruenbaum <inglor@gmail.com>
Sun, 24 Jan 2016 09:35:35 +0000 (11:35 +0200)
committerMyles Borins <mborins@us.ibm.com>
Wed, 2 Mar 2016 22:01:11 +0000 (14:01 -0800)
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 <me@silverwind.io>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Roman Klauke <romaaan.git@gmail.com>>
doc/api/net.markdown

index 109254f..a5f4621 100644 (file)
@@ -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);
 });
@@ -523,7 +524,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');
 });
@@ -576,8 +578,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');
 });
@@ -644,7 +646,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');
@@ -652,7 +655,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');
 });
 ```
@@ -667,7 +672,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: