Skip to content

Commit 5380743

Browse files
tusharmathMyles Borins
authored and
Myles Borins
committed
doc: document socket.destroyed
Fixes: #5898 PR-URL: #6128 Reviewed-By: Colin Ihrig <[email protected]>
1 parent a3fa5db commit 5380743

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/api/net.md

+5
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,11 @@ with options either as either `{port: port, host: host}` or `{path: path}`.
397397
Ensures that no more I/O activity happens on this socket. Only necessary in
398398
case of errors (parse error or so).
399399

400+
### socket.destroyed
401+
402+
A Boolean value that indicates if the connection is destroyed or not. Once a
403+
connection is destroyed no further data can be transferred using it.
404+
400405
### socket.end([data][, encoding])
401406

402407
Half-closes the socket. i.e., it sends a FIN packet. It is possible the

0 commit comments

Comments
 (0)