★ wanayoo — archive 1999 https://github.com/nodejs/node/pull/23933Nouvelle recherche | Portail wanayoo
Skip to content

/node

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
wants to merge 4 commits into from

Conversation

Reviewers

@jasnell jasnell

@Trott Trott

@mcollina mcollina

Assignees
No one assigned
Labels
doc stream
Projects
None yet
Milestone
No milestone
6 participants
@dexterleng @Trott @mcollina @MylesBorins @jasnell @nodejs-github-bot
@dexterleng
Copy link
Contributor

dexterleng commented Oct 28, 2018 •
edited

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 stream labels Oct 28, 2018

@dexterleng dexterleng referenced this pull request Oct 28, 2018

Closed

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

4 of 4 tasks complete
@jasnell

jasnell reviewed Oct 29, 2018
View changes

Show resolved Hide resolved doc/api/stream.md Outdated
@jasnell @dexterleng
doc: address comment 
Co-Authored-By: dexterleng <34204380+dexterleng@users.noreply.github.com>
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
8c4ccca
@dexterleng

This comment has been minimized.

Sign in to view
Copy link
Contributor Author

dexterleng commented Nov 3, 2018

ping @jasnell
@Trott

This comment has been minimized.

Sign in to view
Copy link
Member

Trott commented Nov 4, 2018

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

mcollina reviewed Nov 4, 2018
View changes

Copy link
Member

mcollina left a comment

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

This comment has been minimized.

Sign in to view
Copy link
Contributor Author

dexterleng commented Nov 4, 2018

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

This comment has been minimized.

Sign in to view
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 changes

Show resolved Hide resolved doc/api/stream.md Outdated
@Trott

Trott reviewed Nov 20, 2018
View changes

Show resolved Hide resolved doc/api/stream.md Outdated
@mcollina

mcollina approved these changes Nov 20, 2018
View changes

Copy link
Member

mcollina left a comment

LGTM
@Trott
fixup! doc: address comment
Loading status checks…
4fb9ffe
@Trott

This comment has been minimized.

Sign in to view
Copy link
Member

Trott commented Nov 21, 2018

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

Trott added 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 
PR-URL: nodejs#23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
16a2b5c
@Trott

This comment has been minimized.

Sign in to view
Copy link
Member

Trott commented Nov 21, 2018

Landed in 16a2b5c.

Thanks for the contribution! 🎉

@Trott Trott closed this Nov 21, 2018

targos added a commit that referenced this pull request Nov 21, 2018

@dexterleng @targos
doc: add readable and writable property to Readable and Writable 
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Verified
This commit was signed with a verified signature.
@targos targos Michaël Zasso
GPG key ID: 770F7A9A5AE15600 Learn about signing commits
Loading status checks…
91255cd

rvagg added a commit that referenced this pull request Nov 28, 2018

@dexterleng @rvagg
doc: add readable and writable property to Readable and Writable 
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
41f2e36

@BridgeAR BridgeAR referenced this pull request Dec 5, 2018

Merged

v11.4.0 proposal #24854

4 of 4 tasks complete

This was referenced Dec 7, 2018

Closed
Closed
Closed
Closed
Closed

codebytere added a commit that referenced this pull request Jan 13, 2019

@dexterleng @codebytere
doc: add readable and writable property to Readable and Writable 
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Verified
This commit was signed with a verified signature.
@codebytere codebytere Shelley Vohr
GPG key ID: F13993A75599653C Learn about signing commits
89bfeca

refack added 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 
PR-URL: nodejs#23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
89c4879

@codebytere codebytere referenced this pull request Jan 15, 2019

Merged

v10.15.1 proposal #25346

MylesBorins added a commit that referenced this pull request Jan 29, 2019

@dexterleng @MylesBorins
doc: add readable and writable property to Readable and Writable 
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Verified
This commit was signed with a verified signature.
@MylesBorins MylesBorins Myles Borins
GPG key ID: 933B01F40B5CA946 Learn about signing commits
3dd4394

codebytere added a commit that referenced this pull request Jan 29, 2019

@dexterleng @codebytere
doc: add readable and writable property to Readable and Writable 
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Verified
This commit was signed with a verified signature.
@codebytere codebytere Shelley Vohr
GPG key ID: F13993A75599653C Learn about signing commits
f918ad8
@MylesBorins

This comment has been minimized.

Sign in to view
Copy link
Member

MylesBorins commented Jan 29, 2019

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

codebytere added a commit that referenced this pull request Jan 29, 2019

@dexterleng @codebytere
doc: add readable and writable property to Readable and Writable 
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Verified
This commit was signed with a verified signature.
@codebytere codebytere Shelley Vohr
GPG key ID: F13993A75599653C Learn about signing commits
a4d6866

codebytere added a commit that referenced this pull request Jan 29, 2019

@dexterleng @codebytere
doc: add readable and writable property to Readable and Writable 
PR-URL: #23933
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Verified
This commit was signed with a verified signature.
@codebytere codebytere Shelley Vohr
GPG key ID: F13993A75599653C Learn about signing commits
6ba6ce6

This was referenced Jan 29, 2019

Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.