doc: mention node:stream/consumers in stream overview#62613
Open
NinadUbale wants to merge 4 commits intonodejs:mainfrom
Open
doc: mention node:stream/consumers in stream overview#62613NinadUbale wants to merge 4 commits intonodejs:mainfrom
NinadUbale wants to merge 4 commits intonodejs:mainfrom
Conversation
Adds a reference to the node:stream/consumers utility functions in the main stream documentation to improve discoverability. Refs: nodejs#62535
nodejs-github-bot
added
doc
jasnell
reviewed
Apr 6, 2026
jasnell
reviewed
Apr 6, 2026
|
|
||
| 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. | ||
| For common tasks like reading a stream into a string or buffer, the |
Member
There was a problem hiding this comment.
Suggested change
| For common tasks like reading a stream into a string or buffer, the | |
| For common tasks like reading a stream into a string or buffer, the |
jasnell
reviewed
Apr 6, 2026
doc/api/stream.md
Outdated
| 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. | ||
| For common tasks like reading a stream into a string or buffer, the | ||
| [`node:stream/consumers`](webstreams.md#utility-consumers) module provides |
Member
There was a problem hiding this comment.
The actual url should be moved to the bottom of the page with the rest of them...
Author
|
@jasnell Thanks for the review and guidance! I've removed the stray markdown tag, added the blank line, and moved the URL reference to the bottom of the file as requested. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a brief reference to the
node:stream/consumersutility functions in the main stream documentation (doc/api/stream.md).As discussed in issue #62535, the
node:stream/consumersmodule provides convenient, "batteries-included" utility functions that are often missed by developers who instead write manual boilerplate to consume streams into strings or buffers.Linking it directly where the docs state "It is usually not necessary to use the
node:streammodule to consume streams" greatly improves discoverability for developers.Fixes #62535