summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Noordhuis <info@bnoordhuis.nl>2012-10-01 22:27:19 +0200
committerBen Noordhuis <info@bnoordhuis.nl>2012-10-03 00:49:27 +0200
commitf624be40938a9e72a747a7397a8e11d837760138 (patch)
tree7baace5ffc45b8ca88be01182aafbaac895458cf
parentb90c1502e5320f300e23724d774f634274c82daa (diff)
downloadnode-f624be40938a9e72a747a7397a8e11d837760138.tar.gz
doc: stream: clarify meaning of 'drain' event
-rw-r--r--doc/api/stream.markdown4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown
index 941416748..e02765af2 100644
--- a/doc/api/stream.markdown
+++ b/doc/api/stream.markdown
@@ -120,8 +120,8 @@ A `Writable Stream` has the following methods, members, and events.
`function () { }`
-After a `write()` method returned `false`, this event is emitted to
-indicate that it is safe to write again.
+Emitted when the stream's write queue empties and it's safe to write without
+buffering again. Listen for it when `stream.write()` returns `false`.
### Event: 'error'