Browse Source

net: fix `new net.Socket` documentation

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

fix #6541
v0.10.23-release
Fedor Indutny 11 years ago
parent
commit
5885f464f0
  1. 10
      doc/api/net.markdown

10
doc/api/net.markdown

@ -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])

Loading…
Cancel
Save