Permalink
Browse files

correct documentation of Stream#destroy

  • Loading branch information...
1 parent 8a9e8d6 commit 7accaeb490afdae968ef51372e159fb39e92d303 @dominictarr dominictarr committed with isaacs Jul 7, 2012
Showing with 3 additions and 2 deletions.
  1. +3 −2 doc/api/stream.markdown
View
@@ -174,8 +174,9 @@ Same as above but with a `buffer`.
### stream.destroy()
-Closes the underlying file descriptor. Stream will not emit any more events.
-Any queued write data will not be sent.
+Closes the underlying file descriptor. Stream is no longer `writable` nor `readable`.
+the stream will not emit any more 'data', or 'end' events. Any queued write data will not be sent.
+the stream should emit 'close' event once it's resources have been disposed of.
### stream.destroySoon()

0 comments on commit 7accaeb

Please sign in to comment.