Skip to content

doc: various improvements to net.md #11636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
joyeecheung wants to merge 7 commits into from
+163 −123
Closed

doc: various improvements to net.md #11636

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f6860a9
doc: various improvements to net.md
joyeecheung Mar 1, 2017
d1ea3d2
add stream-based
joyeecheung Mar 1, 2017
5896e3e
socket(7), wrap links, arbitrary port
joyeecheung Mar 1, 2017
5102522
fix line wrap
joyeecheung Mar 1, 2017
b78b5f3
fix link sort order
joyeecheung Mar 3, 2017
fb61a63
address comments
joyeecheung Mar 3, 2017
3686d75
fix wrap
joyeecheung Mar 3, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fix wrap
  • Loading branch information
@joyeecheung
joyeecheung committed Mar 3, 2017
commit 3686d75c1f47917b1597fba06e8c06caf3dfb7cb
13 changes: 7 additions & 6 deletions doc/api/net.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
> Stability: 2 - Stable

The `net` module provides an asynchronous network API for creating stream-based
servers ([`net.createServer()`][]) and clients ([`net.createConnection()`][]) that implement TCP
or local communications (domain sockets on UNIX, named pipes on Windows).
It can be accessed using:
servers ([`net.createServer()`][]) and clients ([`net.createConnection()`][])
that implement TCP or local communications (domain sockets on UNIX, named pipes
on Windows). It can be accessed using:

```js
const net = require('net');
Expand Down Expand Up @@ -162,8 +162,8 @@ Note:

One of the most common errors raised when listening is `EADDRINUSE`.
This happens when another server is already listening on the requested
`port` / `path` / `handle`. One way to handle this would be to retry after a certain
amount of time:
`port` / `path` / `handle`. One way to handle this would be to retry
after a certain amount of time:

```js
server.on('error', (e) => {
Expand All @@ -190,7 +190,8 @@ Start a server listening for connections on a given `handle` that has
already been bound to a port, a UNIX domain socket, or a Windows named pipe.

The `handle` object can be either a server, a socket (anything with an
underlying `_handle` member), or an object with a `fd` member that is a valid file descriptor.
underlying `_handle` member), or an object with a `fd` member that is a
valid file descriptor.

*Note*: Listening on a file descriptor is not supported on Windows.

Expand Down