doc,stream: clarify 'data', pipe() and 'readable'

We stated that 'data' and pipe() are preferred over 'readable'. This commit clarifies that 'data' and pipe() are easier to understand, but 'readable' might result in increased throughput. Fixes: #11587 PR-URL: #13432 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Jul 17, 2017 · 0d35bcd · 0d35bcd
1 parent cc492c3
commit 0d35bcd
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -739,7 +739,8 @@ end
 ```
 
 *Note*: In general, the `readable.pipe()` and `'data'` event mechanisms are
-preferred over the use of the `'readable'` event.
+easier to understand than the `'readable'` event.
+However, handling `'readable'` might result in increased throughput.
 
 ##### readable.isPaused()
 <!-- YAML