From 5380743208085af3dcb2b6a3b12b9772129e269d Mon Sep 17 00:00:00 2001 From: Tushar Mathur Date: Sat, 9 Apr 2016 10:18:13 +0530 Subject: [PATCH] doc: document socket.destroyed Fixes: https://github.com/nodejs/node/issues/5898 PR-URL: https://github.com/nodejs/node/pull/6128 Reviewed-By: Colin Ihrig --- doc/api/net.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/api/net.md b/doc/api/net.md index 0e2fc4f8e4c406..a5590bdad1491b 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -397,6 +397,11 @@ with options either as either `{port: port, host: host}` or `{path: path}`. Ensures that no more I/O activity happens on this socket. Only necessary in case of errors (parse error or so). +### socket.destroyed + +A Boolean value that indicates if the connection is destroyed or not. Once a +connection is destroyed no further data can be transferred using it. + ### socket.end([data][, encoding]) Half-closes the socket. i.e., it sends a FIN packet. It is possible the