Permalink
Browse files

writable stream api has destroySoon() for exiting after data queue ha…

…s been drained
  • Loading branch information...
1 parent 5e78f57 commit 67913a023251dfd881b631c4eda8cac9ad79ed3e @zzak zzak committed with ry Feb 18, 2011
Showing with 6 additions and 0 deletions.
  1. +6 −0 doc/api/streams.markdown
View
6 doc/api/streams.markdown
@@ -170,3 +170,9 @@ Same as above but with a `buffer`.
### stream.destroy()
Closes the underlying file descriptor. Stream will not emit any more events.
+
+### stream.destroySoon()
+
+After the write queue is drained, close the file descriptor. `destroySoon()`
+can still destroy straight away, as long as there is no data left in the queue
+for writes.

0 comments on commit 67913a0

Please sign in to comment.