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: add readable and writable property to Readable and Writable #23933

Closed
wants to merge 4 commits into from
Closed

doc: add readable and writable property to Readable and Writable #23933

wants to merge 4 commits into from

Conversation

dexterleng
Copy link
Contributor

@dexterleng dexterleng commented Oct 28, 2018 •
edited
Loading

Issue #21431

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@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 Oct 28, 2018
@dexterleng dexterleng mentioned this pull request Oct 28, 2018
Closed
4 tasks
jasnell
jasnell reviewed Oct 29, 2018
View reviewed changes
doc/api/stream.md Outdated Show resolved Hide resolved
@jasnell @dexterleng
doc: address comment
8c4ccca 
Co-Authored-By: dexterleng <34204380+dexterleng@users.noreply.github.com>
@dexterleng
Copy link
Contributor Author

ping @jasnell

@Trott
Copy link
Member

Trott commented Nov 4, 2018

@nodejs/streams @nodejs/documentation This could use some reviews.

mcollina
mcollina reviewed Nov 4, 2018
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.

The default value is slightly different, and the meaning as well. writable  is true  when it's safe to call write(), and readable is true when it's safe to call read().

The problem is that some of the core and ecosystem streams sets readable  or writable to false to take into account a delayed open scenario.

@dexterleng
Copy link
Contributor Author

The default value is slightly different, and the meaning as well.

@mcollina Could you elaborate? In the constructor of Readable and Writable the properties are both true.

@mcollina
Copy link
Member

mcollina commented Nov 4, 2018

Check out https://github.com/nodejs/node/blob/master/lib/_stream_duplex.js#L55-L66.

Trott
Trott reviewed Nov 20, 2018
View reviewed changes
doc/api/stream.md Outdated Show resolved Hide resolved
Trott
Trott reviewed Nov 20, 2018
View reviewed changes
doc/api/stream.md Outdated Show resolved Hide resolved
mcollina
mcollina approved these changes Nov 20, 2018
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

@Trott
Copy link
Member

Trott commented Nov 21, 2018

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

Trott pushed a commit to Trott/io.js that referenced this pull request Nov 21, 2018
@dexterleng @Trott
doc: add readable and writable property to Readable and Writable
16a2b5c 
PR-URL: nodejs#23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@Trott
Copy link
Member

Trott commented Nov 21, 2018

Landed in 16a2b5c.

Thanks for the contribution! 🎉

@Trott Trott closed this Nov 21, 2018
targos pushed a commit that referenced this pull request Nov 21, 2018
@dexterleng @targos
doc: add readable and writable property to Readable and Writable
91255cd 
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
rvagg pushed a commit that referenced this pull request Nov 28, 2018
@dexterleng @rvagg
doc: add readable and writable property to Readable and Writable
41f2e36 
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@BridgeAR BridgeAR mentioned this pull request Dec 5, 2018
Merged
4 tasks
This was referenced Dec 7, 2018
Closed
Closed
Closed
Closed
Closed
codebytere pushed a commit that referenced this pull request Jan 13, 2019
@dexterleng @codebytere
doc: add readable and writable property to Readable and Writable
89bfeca 
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
refack pushed a commit to refack/node that referenced this pull request Jan 14, 2019
@dexterleng @refack
doc: add readable and writable property to Readable and Writable
89c4879 
PR-URL: nodejs#23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@codebytere codebytere mentioned this pull request Jan 15, 2019
Merged
@MylesBorins
Copy link
Contributor

FWIW this landed with REPLACEME tags and subsequently got updated with an 11.x number for when it landed... which is innacurate

codebytere pushed a commit that referenced this pull request Jan 29, 2019
@dexterleng @codebytere
doc: add readable and writable property to Readable and Writable
a4d6866 
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
codebytere pushed a commit that referenced this pull request Jan 29, 2019
@dexterleng @codebytere
doc: add readable and writable property to Readable and Writable
6ba6ce6 
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
This was referenced Jan 29, 2019
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
@antsmartian antsmartian mentioned this pull request May 13, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Trott Trott Trott left review comments

@jasnell jasnell jasnell left review comments

@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.
6 participants
@dexterleng @Trott @mcollina @MylesBorins @jasnell @nodejs-github-bot