From db4cb338be7eb32e4bcf300a3fd492f700142ccc Mon Sep 17 00:00:00 2001 From: James M Snell Date: Fri, 14 Aug 2015 10:46:43 -0700 Subject: [PATCH] doc: clarification on the 'close' event per: https://github.com/joyent/node/pull/8209 originally submitted by @jeromew Reviewed By: Sakthipriyan Vairamani PR-URL: https://github.com/nodejs/node/pull/2378 --- doc/api/stream.markdown | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown index d32a25e..2022ef2 100644 --- a/doc/api/stream.markdown +++ b/doc/api/stream.markdown @@ -230,8 +230,11 @@ readable.on('end', function() { #### Event: 'close' -Emitted when the underlying resource (for example, the backing file -descriptor) has been closed. Not all streams will emit this. +Emitted when the stream and any of its underlying resources (a file +descriptor, for example) have been closed, no more events will be +emitted, and no further computation will occur. + +Not all streams will emit the 'close' event. #### Event: 'error' -- 2.7.4