Skip to content

doc: stream.isReadable and stream.isWritable API fixups #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

Merged
nodejs-github-bot merged 6 commits into from
Sep 7, 2025
+8 −1
Merged

doc: stream.isReadable and stream.isWritable API fixups #59089

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c2bcc6f
lib: fix isReadable and isWritable return type value
joaoGabriel55 Jul 16, 2025
53c228b
test: write test-streem-utils.js test file
joaoGabriel55 Jul 16, 2025
4e040c1
rollback: undo the last change and delete the unnecessary test
joaoGabriel55 Jul 17, 2025
301d58c
doc: update isReadable and add isWritable doc
joaoGabriel55 Jul 17, 2025
844b176
lint: run make lint-js
joaoGabriel55 Jul 17, 2025
5e4640d
doc: clarify return values for isReadable and isWritable functions
joaoGabriel55 Jul 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3084,10 +3084,17 @@ changes:
-->

* `stream` {Readable|Duplex|ReadableStream}
* Returns: {boolean}
* Returns: {boolean|null} - Only returns a `null` if type of `stream.readable` argument passed is not a boolean.

Returns whether the stream is readable.

### `stream.isWritable(stream)`

* `stream` {Writable|Duplex|WritableStream}
* Returns: {boolean|null} - Only returns a `null` if type of `stream.writable` argument passed is not a boolean.

Returns whether the stream is writable.

### `stream.Readable.from(iterable[, options])`

<!-- YAML
Expand Down
6 changes: 3 additions & 3 deletions lib/internal/streams/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,16 +176,16 @@ function isReadable(stream) {
if (isDestroyed(stream)) return false;
return isReadableNodeStream(stream) &&
stream.readable &&
!isReadableFinished(stream);
!isReadableFinished(stream)
}

function isWritable(stream) {
if (stream && stream[kIsWritable] != null) return stream[kIsWritable];
if (typeof stream?.writable !== 'boolean') return null;
if (typeof stream?.writable !== 'boolean') return null
if (isDestroyed(stream)) return false;
return isWritableNodeStream(stream) &&
stream.writable &&
!isWritableEnded(stream);
!isWritableEnded(stream)
}

function isFinished(stream, opts) {
Expand Down