Skip to content

doc: make sure that calls to .read() are looped #25375

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Closed
wants to merge 4 commits into from
Closed

doc: make sure that calls to .read() are looped #25375

wants to merge 4 commits into from

Conversation

mcollina
Copy link
Member

@mcollina mcollina commented Jan 7, 2019 •
edited
Loading

The 'readable' event assumes that calls to readable.read() happens
within that event handler until readable.read() returns null.

Fixes: #20503

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@mcollina
doc: make sure that calls to .read() are looped
d0b7b13 
The 'readable' event assumes that calls to readable.read() happens
within that event handler until readable.read() returns null.

Fixes: nodejs#20503
@nodejs-github-bot
Copy link
Collaborator

@mcollina build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/2161/pipeline

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jan 7, 2019
@mcollina mcollina requested a review from addaleax January 7, 2019 14:50
lpinca
lpinca reviewed Jan 7, 2019
View reviewed changes
doc/api/stream.md
@@ -1012,6 +1012,10 @@ readable.on('readable', () => {
});
```

Note that the `while` loop is necessary when processing data with
`readable.read()`. Only after `readable.read()` returns null,
[`'readable'`]() will be emitted.
Copy link
Member

Choose a reason for hiding this comment

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

will be emitted again?

lpinca and others added 3 commits January 9, 2019 12:53
@lpinca @mcollina
Update doc/api/crypto.md
5c0b08c 
Co-Authored-By: mcollina <matteo.collina@gmail.com>
@lpinca @mcollina
Update doc/api/crypto.md
a678441 
Co-Authored-By: mcollina <matteo.collina@gmail.com>
@lpinca @mcollina
Update doc/api/stream.md
840e2a3 
Co-Authored-By: mcollina <matteo.collina@gmail.com>
@mcollina
Copy link
Member Author

mcollina commented Jan 9, 2019

CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/2199/

@mcollina
Copy link
Member Author

mcollina commented Jan 9, 2019

cc @lpinca

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 10, 2019
@mcollina
Copy link
Member Author

Landed in 2d2f82c

@mcollina mcollina closed this Jan 10, 2019
@mcollina mcollina deleted the fix-readable-docs branch January 10, 2019 10:20
mcollina added a commit that referenced this pull request Jan 10, 2019
@mcollina
doc: make sure that calls to .read() are looped
2d2f82c 
The 'readable' event assumes that calls to readable.read() happens
within that event handler until readable.read() returns null.

Fixes: #20503
PR-URL: #25375
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@ZYSzys ZYSzys mentioned this pull request Jan 10, 2019
Closed
addaleax pushed a commit that referenced this pull request Jan 14, 2019
@mcollina @addaleax
doc: make sure that calls to .read() are looped
6778261 
The 'readable' event assumes that calls to readable.read() happens
within that event handler until readable.read() returns null.

Fixes: #20503
PR-URL: #25375
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@BridgeAR BridgeAR mentioned this pull request Jan 16, 2019
Merged
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request Jan 16, 2019
@mcollina @BridgeAR
doc: make sure that calls to .read() are looped
0d92b0f 
The 'readable' event assumes that calls to readable.read() happens
within that event handler until readable.read() returns null.

Fixes: nodejs#20503
PR-URL: nodejs#25375
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@MylesBorins MylesBorins mentioned this pull request Jan 24, 2019
Merged
@lpinca lpinca mentioned this pull request Feb 7, 2019
Closed
BethGriggs pushed a commit that referenced this pull request Apr 28, 2019
@mcollina @BethGriggs
doc: make sure that calls to .read() are looped
5875336 
The 'readable' event assumes that calls to readable.read() happens
within that event handler until readable.read() returns null.

Fixes: #20503
PR-URL: #25375
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@BethGriggs BethGriggs mentioned this pull request May 1, 2019
Merged
BethGriggs pushed a commit that referenced this pull request May 10, 2019
@mcollina @BethGriggs
doc: make sure that calls to .read() are looped
bce3960 
The 'readable' event assumes that calls to readable.read() happens
within that event handler until readable.read() returns null.

Fixes: #20503
PR-URL: #25375
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins pushed a commit that referenced this pull request May 16, 2019
@mcollina @MylesBorins
doc: make sure that calls to .read() are looped
530f005 
The 'readable' event assumes that calls to readable.read() happens
within that event handler until readable.read() returns null.

Fixes: #20503
PR-URL: #25375
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This was referenced May 29, 2019
Closed
Closed
Closed
Closed
Closed
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@addaleax addaleax addaleax approved these changes

@lpinca lpinca lpinca approved these changes

@cjihrig cjihrig cjihrig approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@mcollina @nodejs-github-bot @jasnell @addaleax @lpinca @cjihrig @BridgeAR