1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

net: fix new net.Socket documentation

Browse Source 
`Socket` no longer accepts `type` option, and also accepts `readable`,
`writable` options.

fix #6541
This commit is contained in:
Fedor Indutny 2013-11-19 11:02:26 +04:00
parent 5ce50ece16
commit 5885f464f0
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/api/net.markdown
View File

@ -281,12 +281,14 @@ Construct a new socket object.
`options` is an object with the following defaults: `options` is an object with the following defaults:
{ fd: null { fd: null
type: null allowHalfOpen: false,
allowHalfOpen: false readable: false,
writable: false
} }
`fd` allows you to specify the existing file descriptor of socket. `type` `fd` allows you to specify the existing file descriptor of socket.
specified underlying protocol. It can be `'tcp4'`, `'tcp6'`, or `'unix'`. 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. About `allowHalfOpen`, refer to `createServer()` and `'end'` event.
### socket.connect(port, [host], [connectListener]) ### socket.connect(port, [host], [connectListener])