From 7accaeb490afdae968ef51372e159fb39e92d303 Mon Sep 17 00:00:00 2001 From: Dominic Tarr Date: Sat, 7 Jul 2012 12:25:13 +1200 Subject: [PATCH] correct documentation of Stream#destroy --- doc/api/stream.markdown | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown index 66160df63a0..dbc6bb2be71 100644 --- a/doc/api/stream.markdown +++ b/doc/api/stream.markdown @@ -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()