writable stream api has destroySoon() for exiting after data queue has been drained

14 years ago · 67913a0232
1 changed files with 6 additions and 0 deletions
--- a/doc/api/streams.markdown
+++ b/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.