Skip to content

doc, stream: define more cases for event emissions - #53317

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
avivkeller:patch-47
Jun 8, 2024
Merged

doc, stream: define more cases for event emissions#53317
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
avivkeller:patch-47

Conversation

@avivkeller

Copy link
Copy Markdown
Member

Fixes#32709

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

@nodejs-github-botnodejs-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
Copy Markdown
MemberAuthor

CC @nodejs/streams

@mcollinamcollina left a comment

Copy link
Copy Markdown
Member

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
Copy Markdown
MemberAuthor

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 mcollinaJune 4, 2024 11:16

@mcollinamcollina left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm

@mcollina

Copy link
Copy Markdown
Member

Can you lint your commit?

Comment threaddoc/api/stream.md Outdated
@mcollinamcollina added the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 8, 2024
@nodejs-github-botnodejs-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:mainJun 8, 2024
@nodejs-github-bot

Copy link
Copy Markdown
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>
soophoo pushed a commit to soophoo/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>
@targostargos mentioned this pull request Jun 25, 2024
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-ippolitomarco-ippolito mentioned this pull request Jul 19, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.streamIssues 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

@avivkeller@mcollina@nodejs-github-bot@lpinca