Skip to content

Doc(fix): stream.isReadable and stream.isWritable API doc #59089

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
Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Doc(fix): stream.isReadable and stream.isWritable API doc #59089

wants to merge 6 commits into from

Conversation

joaoGabriel55
Copy link

Fixes: #59006

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/streams

@nodejs-github-bot nodejs-github-bot added needs-ci PRs that need a full CI run. stream Issues and PRs related to the stream subsystem. labels Jul 16, 2025
MattiasBuelens
MattiasBuelens reviewed Jul 16, 2025
View reviewed changes
ronag
ronag requested changes Jul 16, 2025
View reviewed changes
Copy link
Member

@ronag ronag left a comment

Choose a reason for hiding this comment

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

null means unknown. I don't think we should change it.

@joaoGabriel55
Copy link
Author

Maybe only changing the API docs to inform that those methods can return Boolean or null, would be good?

@anonrig
Copy link
Member

anonrig commented Jul 17, 2025

Maybe only changing the API docs to inform that those methods can return Boolean or null, would be good?

Yes that's a really good path forward!

@joaoGabriel55 joaoGabriel55 marked this pull request as ready for review July 17, 2025 17:52
geeksilva97
geeksilva97 reviewed Jul 17, 2025
View reviewed changes
geeksilva97
geeksilva97 reviewed Jul 17, 2025
View reviewed changes
geeksilva97
geeksilva97 reviewed Jul 17, 2025
View reviewed changes
@geeksilva97 geeksilva97 added doc Issues and PRs related to the documentations. and removed needs-ci PRs that need a full CI run. labels Jul 17, 2025
@geeksilva97 geeksilva97 requested a review from ronag July 17, 2025 17:58
benjamingr
benjamingr approved these changes Jul 17, 2025
View reviewed changes
Copy link
Member

@benjamingr benjamingr left a comment

Choose a reason for hiding this comment

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

Yes this (the docs fix) is the correct fix

@joaoGabriel55 joaoGabriel55 changed the title Fix: stream.isReadable and stream.isWritable return null instead of false Doc(fix): stream.isReadable and stream.isWritable doc Jul 17, 2025
@joaoGabriel55 joaoGabriel55 changed the title Doc(fix): stream.isReadable and stream.isWritable doc Doc(fix): stream.isReadable and stream.isWritable API doc Jul 17, 2025
MattiasBuelens
MattiasBuelens reviewed Jul 17, 2025
View reviewed changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Ethan-Arrowood Ethan-Arrowood Ethan-Arrowood approved these changes

@jasnell jasnell jasnell approved these changes

@MattiasBuelens MattiasBuelens MattiasBuelens approved these changes

@benjamingr benjamingr benjamingr approved these changes

@lpinca lpinca lpinca approved these changes

@geeksilva97 geeksilva97 geeksilva97 approved these changes

@ronag ronag Awaiting requested review from ronag

Requested changes must be addressed to merge this pull request.

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.

stream.isReadable and stream.isWritable return null instead of false
10 participants
@joaoGabriel55 @nodejs-github-bot @anonrig @jasnell @MattiasBuelens @benjamingr @lpinca @ronag @geeksilva97 @Ethan-Arrowood