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.

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

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

Closed

Conversation

dexterleng
Copy link
Contributor

@dexterleng dexterleng commented Oct 28, 2018

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
doc/api/stream.md Outdated Show resolved Hide resolved
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.

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

doc/api/stream.md Outdated Show resolved Hide resolved
doc/api/stream.md Outdated Show resolved Hide resolved
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

Trott pushed a commit to Trott/io.js that referenced this pull request Nov 21, 2018
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
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
rvagg pushed a commit that referenced this pull request Nov 28, 2018
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@BridgeAR BridgeAR mentioned this pull request Dec 5, 2018
4 tasks
codebytere pushed a commit that referenced this pull request Jan 13, 2019
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
PR-URL: nodejs#23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@codebytere codebytere mentioned this pull request Jan 15, 2019
@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
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
codebytere pushed a commit that referenced this pull request Jan 29, 2019
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants