Skip to content

Commit 00e1ea7

Browse files
committed
doc: mention node:stream/consumers in stream overview
1 parent 4f08c64 commit 00e1ea7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

doc/api/stream.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ are both stream instances.
1616
Streams can be readable, writable, or both. All streams are instances of
1717
[`EventEmitter`][].
1818

19+
```markdown
1920
To access the `node:stream` module:
2021

2122
```js
@@ -24,6 +25,9 @@ const stream = require('node:stream');
2425

2526
The `node:stream` module is useful for creating new types of stream instances.
2627
It is usually not necessary to use the `node:stream` module to consume streams.
28+
For common tasks like reading a stream into a string or buffer, the
29+
[`node:stream/consumers`](webstreams.md#utility-consumers) module provides
30+
convenient utility functions.
2731

2832
## Organization of this document
2933

0 commit comments

Comments
 (0)