diff options
| author | Rich Trott <rtrott@gmail.com> | 2018-03-03 22:07:48 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-03-06 22:30:09 -0800 |
| commit | cb5f9a6d871f6b2e0da8fa72dc2e91fb37ef9713 (patch) | |
| tree | 0456de770d22a8badc99f5b70c369d3b5df65e1b /doc/api/stream.md | |
| parent | fc9ddd9cd9f9d3410f8f7aca2c5ee58ed4101c3b (diff) | |
| download | node-new-cb5f9a6d871f6b2e0da8fa72dc2e91fb37ef9713.tar.gz | |
doc: make suggestion more direct in stream.md
PR-URL: https://github.com/nodejs/node/pull/19124
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc/api/stream.md')
| -rw-r--r-- | doc/api/stream.md | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index b43f66996b..e1642a013a 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -955,9 +955,8 @@ readable.on('readable', () => { }); ``` -In general, it is recommended that developers avoid the use of the `'readable'` -event and the `readable.read()` method in favor of using either -`readable.pipe()` or the `'data'` event. +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 |