Skip to content

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

Closed
mcollina wants to merge 4 commits into
nodejs:masterfrom
mcollina:fix-readable-docs
Closed

doc: make sure that calls to .read() are looped#25375
mcollina wants to merge 4 commits into
nodejs:masterfrom
mcollina:fix-readable-docs

Conversation

@mcollina

@mcollinamcollina commented Jan 7, 2019

Copy link
Copy Markdown
Member

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

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

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Jan 7, 2019
@mcollina
mcollina requested a review from addaleaxJanuary 7, 2019 14:50
Comment threaddoc/api/crypto.md Outdated
Comment threaddoc/api/crypto.md Outdated
Comment threaddoc/api/stream.md Outdated
Comment threaddoc/api/stream.md

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

lpincaand others added 3 commits January 9, 2019 12:53
Co-Authored-By: mcollina <matteo.collina@gmail.com>
Co-Authored-By: mcollina <matteo.collina@gmail.com>
Co-Authored-By: mcollina <matteo.collina@gmail.com>
@mcollina

Copy link
Copy Markdown
MemberAuthor

@mcollina

Copy link
Copy Markdown
MemberAuthor

cc @lpinca

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

Landed in 2d2f82c

@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
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>
addaleax pushed a commit that referenced this pull request Jan 14, 2019
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>
@BridgeARBridgeAR mentioned this pull request Jan 16, 2019
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request Jan 16, 2019
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>
@MylesBorinsMylesBorins mentioned this pull request Jan 24, 2019
BethGriggs pushed a commit that referenced this pull request Apr 28, 2019
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>
@BethGriggsBethGriggs mentioned this pull request May 1, 2019
BethGriggs pushed a commit that referenced this pull request May 10, 2019
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
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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@mcollina@nodejs-github-bot@jasnell@addaleax@lpinca@cjihrig@BridgeAR