diff options
| author | Rich Trott <rtrott@gmail.com> | 2018-03-07 09:33:44 +0300 |
|---|---|---|
| committer | Myles Borins <mylesborins@google.com> | 2018-09-06 19:40:52 +0300 |
| commit | 7ed297d5288aaba159fe9f088c5d5fe54888c1e2 (patch) | |
| tree | b72ccb952676321dec4d28bd7b1d9840a1468551 /doc | |
| parent | 94d27e21ef064f8905b7d022db6aa0da6cc4cba5 (diff) | |
doc: remove warning against readable/readable.read
Remove suggestion to avoid `readable` event and `readabe.read()` method.
No explanation was provided for this suggestion.
Backport-PR-URL: https://github.com/nodejs/node/pull/22380
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')
| -rw-r--r-- | doc/api/stream.md | 3 |
1 files changed, 0 insertions, 3 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 7738e210c9a..6b51585e691 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -934,9 +934,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. |