Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Jun 8, 2024
Merged

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

merged 1 commit into from
Jun 8, 2024

Conversation

RedYetiDev
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
@RedYetiDev
Copy link
Member Author

CC @nodejs/streams

mcollina
mcollina requested changes Jun 4, 2024
View reviewed changes
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.

@RedYetiDev
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.

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

lpinca
lpinca reviewed Jun 7, 2024
View reviewed changes
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
16 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 0b02008

targos pushed a commit that referenced this pull request Jun 20, 2024
@RedYetiDev @targos
doc: define more cases for stream event emissions
d9182d0 
PR-URL: #53317
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
EliphazBouye pushed a commit to EliphazBouye/node that referenced this pull request Jun 20, 2024
@RedYetiDev @EliphazBouye
doc: define more cases for stream event emissions
6038941 
PR-URL: nodejs#53317
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
bmeck pushed a commit to bmeck/node that referenced this pull request Jun 22, 2024
@RedYetiDev @bmeck
doc: define more cases for stream event emissions
9dda383 
PR-URL: nodejs#53317
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@targos targos mentioned this pull request Jun 25, 2024
Merged
@Karliz24 Karliz24 mentioned this pull request Jul 9, 2024
Open
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
@RedYetiDev @marco-ippolito
doc: define more cases for stream event emissions
cc16ca9 
PR-URL: #53317
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
@RedYetiDev @marco-ippolito
doc: define more cases for stream event emissions
55ac53c 
PR-URL: #53317
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@marco-ippolito marco-ippolito mentioned this pull request Jul 19, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lpinca lpinca lpinca approved these changes

@mcollina mcollina mcollina 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
@RedYetiDev @mcollina @nodejs-github-bot @lpinca