doc: clarify error handling in net.createServer
authorDirceu Pereira Tiegs <dirceutiegs@gmail.com>
Sun, 21 Feb 2016 18:07:27 +0000 (15:07 -0300)
committerMyles Borins <mborins@us.ibm.com>
Wed, 2 Mar 2016 22:01:11 +0000 (14:01 -0800)
Remove indications that an error argument is sent to the `listen()` callback.

Fixes: https://github.com/nodejs/node/issues/5345
PR-URL: https://github.com/nodejs/node/pull/5353
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
doc/api/net.markdown

index 20e06d1..bc8aa1a 100644 (file)
@@ -48,11 +48,13 @@ Example:
 ```js
 var server = net.createServer((socket) => {
   socket.end('goodbye\n');
+}).on('error', (err) => {
+  // handle errors here
+  throw err;
 });
 
 // grab a random port.
-server.listen((err) => {
-  if (err) throw err;
+server.listen(() => {
   address = server.address();
   console.log('opened server on %j', address);
 });
@@ -655,9 +657,10 @@ const server = net.createServer((c) => {
   c.write('hello\r\n');
   c.pipe(c);
 });
-server.listen(8124, (err) => {
-  // 'listening' listener
-  if (err) throw err;
+server.on('error', (err) => {
+  throw err;
+});
+server.listen(8124, () => {
   console.log('server bound');
 });
 ```
@@ -672,9 +675,8 @@ 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', (err) => {
-  // 'listening' listener
-  if (err) throw err;
+server.listen('/tmp/echo.sock', () => {
+  console.log('server bound');
 });
 ```