Skip to content

Commit

Permalink
Update doc/api/stream.md
Browse files Browse the repository at this point in the history
Co-authored-by: Vincent Weevers <mail@vincentweevers.nl>
  • Loading branch information
benjamingr and vweevers committed Jan 16, 2022
1 parent 091e7f4 commit 7212774
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/api/stream.md
Expand Up @@ -1907,8 +1907,9 @@ This method allows easily obtaining the contents of a stream. If the
stream is in [object mode][object-mode] an array of its contents is returned.
If the stream is not in object mode a Buffer containing its data is returned.

As this method reads the entire stream into memory, it negates many of the
benefits of streams and should not be used in performance sensitive situations.
As this method reads the entire stream into memory, it negates the benefits of
streams. It's intended for interoperability and convenience, not as the primary
way to consume streams.

```mjs
import { Readable } from 'stream';
Expand Down

0 comments on commit 7212774

Please sign in to comment.