From cb5f9a6d871f6b2e0da8fa72dc2e91fb37ef9713 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 3 Mar 2018 22:07:48 -0800 Subject: doc: make suggestion more direct in stream.md PR-URL: https://github.com/nodejs/node/pull/19124 Reviewed-By: Colin Ihrig Reviewed-By: James M Snell Reviewed-By: Ruben Bridgewater --- doc/api/stream.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'doc/api/stream.md') 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 -- cgit v1.2.3