summaryrefslogtreecommitdiff
path: root/doc/api/stream.md
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2018-03-06 22:33:44 -0800
committerRich Trott <rtrott@gmail.com>2018-03-08 22:40:19 -0800
commit0f05173f49ab31aafc48c0046d9b0cb5e38fb6be (patch)
tree2c415ab3e3a2a61b45384df09d67ba2630a4ca56 /doc/api/stream.md
parent3dfce5cdad554d2eabd001a4a917efa143739711 (diff)
downloadandroid-node-v8-0f05173f49ab31aafc48c0046d9b0cb5e38fb6be.tar.gz
android-node-v8-0f05173f49ab31aafc48c0046d9b0cb5e38fb6be.tar.bz2
android-node-v8-0f05173f49ab31aafc48c0046d9b0cb5e38fb6be.zip
doc: remove warning against readable/readable.read
Remove suggestion to avoid `readable` event and `readabe.read()` method. No explanation was provided for this suggestion. PR-URL: https://github.com/nodejs/node/pull/19193 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Chen Gang <gangc.cxy@foxmail.com> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Diffstat (limited to 'doc/api/stream.md')
-rw-r--r--doc/api/stream.md3
1 files changed, 0 insertions, 3 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md
index e1642a013a..01a1713dad 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -955,9 +955,6 @@ readable.on('readable', () => {
});
```
-Avoid the use of the `'readable'` event and the `readable.read()` method in
-favor of using either `readable.pipe()` or the `'data'` event.
-
A Readable stream in object mode will always return a single item from
a call to [`readable.read(size)`][stream-read], regardless of the value of the
`size` argument.