Skip to content

Commit 7212774

Browse files
benjamingrvweevers
andauthored
Update doc/api/stream.md
Co-authored-by: Vincent Weevers <[email protected]>
1 parent 091e7f4 commit 7212774

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/api/stream.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1907,8 +1907,9 @@ This method allows easily obtaining the contents of a stream. If the
19071907
stream is in [object mode][object-mode] an array of its contents is returned.
19081908
If the stream is not in object mode a Buffer containing its data is returned.
19091909

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

19131914
```mjs
19141915
import { Readable } from 'stream';

0 commit comments

Comments
 (0)