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

doc: add argument information for socket.destroy()

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/7238
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
This commit is contained in:
Rich Trott 2016-06-08 16:31:54 -07:00
parent ecc48a154d
commit 92adbe4793
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/api/net.md
View File

@ -512,7 +512,7 @@ If `true` - [`socket.connect(options[, connectListener])`][`socket.connect(optio
haven't yet finished. Will be set to `false` before emitting `connect` event
and/or calling [`socket.connect(options[, connectListener])`][`socket.connect(options, connectListener)`]'s callback.
### socket.destroy()
### socket.destroy([exception])
<!-- YAML
added: v0.1.90
-->
@ -520,6 +520,9 @@ added: v0.1.90
Ensures that no more I/O activity happens on this socket. Only necessary in
case of errors (parse error or so).
If `exception` is specified, an [`'error'`][] event will be emitted and any
listeners for that event will receive `exception` as an argument.
### socket.destroyed
A Boolean value that indicates if the connection is destroyed or not. Once a