net: fix `new net.Socket` documentation
authorFedor Indutny <fedor.indutny@gmail.com>
Tue, 19 Nov 2013 07:02:26 +0000 (11:02 +0400)
committerFedor Indutny <fedor.indutny@gmail.com>
Tue, 19 Nov 2013 08:50:16 +0000 (12:50 +0400)
`Socket` no longer accepts `type` option, and also accepts `readable`,
`writable` options.

fix #6541

doc/api/net.markdown

index d80e80b..513acb1 100644 (file)
@@ -281,12 +281,14 @@ Construct a new socket object.
 `options` is an object with the following defaults:
 
     { fd: null
-      type: null
-      allowHalfOpen: false
+      allowHalfOpen: false,
+      readable: false,
+      writable: false
     }
 
-`fd` allows you to specify the existing file descriptor of socket. `type`
-specified underlying protocol. It can be `'tcp4'`, `'tcp6'`, or `'unix'`.
+`fd` allows you to specify the existing file descriptor of socket.
+Set `readable` and/or `writable` to `true` to allow reads and/or writes on this
+socket (NOTE: Works only when `fd` is passed).
 About `allowHalfOpen`, refer to `createServer()` and `'end'` event.
 
 ### socket.connect(port, [host], [connectListener])