Skip to content

Commit

Permalink
doc: clarification on the 'close' event
Browse files Browse the repository at this point in the history
per: nodejs/node-v0.x-archive#8209

originally submitted by @jeromew

Reviewed By: Sakthipriyan Vairamani <[email protected]>
PR-URL: #2378
  • Loading branch information
jasnell authored and rvagg committed Aug 26, 2015
1 parent f6d3b87 commit 52018e7
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions doc/api/stream.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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'

Expand Down

0 comments on commit 52018e7

Please sign in to comment.