diff --git a/doc/api/stream.md b/doc/api/stream.md index 20892fb6cb0a87..30221f367e341e 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -16,6 +16,7 @@ are both stream instances. Streams can be readable, writable, or both. All streams are instances of [`EventEmitter`][]. + To access the `node:stream` module: ```js @@ -25,8 +26,11 @@ const stream = require('node:stream'); The `node:stream` module is useful for creating new types of stream instances. It is usually not necessary to use the `node:stream` module to consume streams. -## Organization of this document +For common tasks like reading a stream into a string or buffer, the +[`node:stream/consumers`][] module provides convenient utility functions. + +## Organization of this document This document contains two primary sections and a third section for notes. The first section explains how to use existing streams within an application. The second section explains how to create new types of streams. @@ -5061,6 +5065,7 @@ contain multi-byte characters. [`Writable`]: #class-streamwritable [`fs.createReadStream()`]: fs.md#fscreatereadstreampath-options [`fs.createWriteStream()`]: fs.md#fscreatewritestreampath-options +[`node:stream/consumers`]: webstreams.md#utility-consumers [`net.Socket`]: net.md#class-netsocket [`process.stderr`]: process.md#processstderr [`process.stdin`]: process.md#processstdin