Skip to content

Instantly share code, notes, and snippets.

/a.patch Secret

Created October 1, 2012 21:21
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save anonymous/82c1be40614b3488da2e to your computer and use it in GitHub Desktop.
Save anonymous/82c1be40614b3488da2e to your computer and use it in GitHub Desktop.
diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown
index a894591..7132a32 100644
--- a/doc/api/stream.markdown
+++ b/doc/api/stream.markdown
@@ -120,8 +120,10 @@ 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.
+The `write()` method may return `false` indicating that node had to enqueue
+the data because the stream endpoint (e.g. network connection) couldn't keep
+up. When that happens, the `drain` event will be emitted when node's queue is
+empty again, and more data can safely be written.
### Event: 'error'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment