From 88293bbdac5249787f85b9e3786922378a749349 Mon Sep 17 00:00:00 2001 From: jeromew Date: Wed, 20 Aug 2014 13:53:53 +0200 Subject: [PATCH] clarify the 'close' event --- 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 e9f6e2c5024..47ab6390270 100644 --- a/doc/api/stream.markdown +++ b/doc/api/stream.markdown @@ -202,8 +202,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 (for example a +file descriptor) have been closed, and no more events will be emitted, +nor will any further computation occur. + +Not all streams will emit this. #### Event: 'error'