Skip to content

Commit

Permalink
doc: check for errors in 'listen' event
Browse files Browse the repository at this point in the history
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: #4834
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Roman Klauke <[email protected]>>
  • Loading branch information
benjamingr authored and rvagg committed Jan 25, 2016
1 parent f462320 commit fa1d453
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions doc/api/net.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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);
});
Expand Down Expand Up @@ -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');
});
Expand Down Expand Up @@ -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');
});
Expand Down Expand Up @@ -644,15 +646,18 @@ 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');
});
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');
});
```
Expand All @@ -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:
Expand Down

0 comments on commit fa1d453

Please sign in to comment.