Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Conversation

avivkeller
Copy link
Member

Fixes #32709

This PR documents more information about Stream's .read() function and the readable event.

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Jun 3, 2024
@avivkeller
Copy link
Member Author

CC @nodejs/streams

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is missing the information that read() is supposed to be called in a loop.

@avivkeller
Copy link
Member Author

This is missing the information that read() is supposed to be called in a loop.

Added the following sentence:
Because a single read() call does not return all the data, using
a while loop may be necessary to continuously read chunks until all data is retrieved.

@avivkeller avivkeller requested a review from mcollina June 4, 2024 11:16
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mcollina
Copy link
Member

mcollina commented Jun 7, 2024

Can you lint your commit?

doc/api/stream.md Outdated Show resolved Hide resolved
@mcollina mcollina added the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 8, 2024
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 8, 2024
@nodejs-github-bot nodejs-github-bot merged commit 0b02008 into nodejs:main Jun 8, 2024
@nodejs-github-bot
Copy link
Collaborator

Landed in 0b02008

targos pushed a commit that referenced this pull request Jun 20, 2024
PR-URL: #53317
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
eliphazb pushed a commit to eliphazb/node that referenced this pull request Jun 20, 2024
PR-URL: nodejs#53317
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
bmeck pushed a commit to bmeck/node that referenced this pull request Jun 22, 2024
PR-URL: nodejs#53317
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
PR-URL: #53317
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
PR-URL: #53317
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: readable events and their emissions

4 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.