FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc, stream: define more cases for event emissions by avivkeller · Pull Request #53317 · nodejs/node · GitHub

/ node Public

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
ConversationCommits (1)ChecksFiles changed
Merged

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

Conversation

avivkeller commented Jun 3, 2024

Copy link
Copy Markdown
Member

Fixes #32709

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

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 commented Jun 4, 2024

Copy link
Copy Markdown
Member Author

CC @nodejs/streams

mcollina requested changes Jun 4, 2024
View reviewed changes

mcollina 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

avivkeller commented Jun 4, 2024

Copy link
Copy Markdown
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 requested a review from mcollina June 4, 2024 11:16
mcollina approved these changes Jun 7, 2024
View reviewed changes

mcollina 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

lgtm

mcollina commented Jun 7, 2024

Copy link
Copy Markdown
Member

Can you lint your commit?

lpinca reviewed Jun 7, 2024
View reviewed changes
Comment thread doc/api/stream.md Outdated
mcollina added the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 8, 2024
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 merged commit 0b02008 into nodejs:main Jun 8, 2024

nodejs-github-bot commented Jun 8, 2024

Copy link
Copy Markdown
Collaborator

Landed in 0b02008

targos pushed a commit that referenced this pull request Jun 20, 2024
doc: define more cases for stream event emissions
d9182d0 
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
doc: define more cases for stream event emissions
6038941 
PR-URL: nodejs#53317
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
targos mentioned this pull request Jun 25, 2024
Merged
Karliz24 mentioned this pull request Jul 9, 2024
Open
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
doc: define more cases for stream event emissions
55ac53c 
PR-URL: #53317
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
marco-ippolito mentioned this pull request Jul 19, 2024
Merged
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

mcollina mcollina approved these changes
lpinca lpinca approved these changes

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

doc: readable events and their emissions

4 participants

Back | FazBrowse Home | New Git URL