Skip to content

Commit 52018e7

Browse files
jasnellrvagg
authored andcommitted
doc: clarification on the 'close' event
per: nodejs/node-v0.x-archive#8209 originally submitted by @jeromew Reviewed By: Sakthipriyan Vairamani <[email protected]> PR-URL: #2378
1 parent f6d3b87 commit 52018e7

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

doc/api/stream.markdown

+5-2
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,11 @@ readable.on('end', function() {
230230

231231
#### Event: 'close'
232232

233-
Emitted when the underlying resource (for example, the backing file
234-
descriptor) has been closed. Not all streams will emit this.
233+
Emitted when the stream and any of its underlying resources (a file
234+
descriptor, for example) have been closed, no more events will be
235+
emitted, and no further computation will occur.
236+
237+
Not all streams will emit the 'close' event.
235238

236239
#### Event: 'error'
237240

0 commit comments

Comments
 (0)