From 1116d3274d8e1aa2b232dc915b64f47a932d56a7 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 3 Mar 2018 22:07:48 -0800 Subject: [PATCH] doc: make suggestion more direct in stream.md Backport-PR-URL: https://github.com/nodejs/node/pull/22380 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(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index 23bb97ea286c50..7738e210c9acd8 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -934,9 +934,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