Skip to content

doc: fix stream.md section order #58811

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
aduh95 merged 1 commit into from
Jun 26, 2025
+38 −38
Merged

doc: fix stream.md section order #58811

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
doc: fix stream.md section order 
For some reason, `stream.isErrored` and `stream.isReadable` sections
were in between `stream.Readable` static methods sections.
  • Loading branch information
@aduh95
aduh95 committed Jun 25, 2025
commit dce162874e1cf93b902cd099d5410e08548a2e74
76 changes: 38 additions & 38 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3050,6 +3050,44 @@

See [`readable.compose(stream)`][] for `stream.compose` as operator.

### `stream.isErrored(stream)`

<!-- YAML
added:
- v17.3.0
- v16.14.0
changes:
- version:
- v24.0.0
- v22.17.0
pr-url: https://github.com/nodejs/node/pull/57513

Check warning on line 3063 in doc/api/stream.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
description: Marking the API stable.
-->

* `stream` {Readable|Writable|Duplex|WritableStream|ReadableStream}
* Returns: {boolean}

Returns whether the stream has encountered an error.

### `stream.isReadable(stream)`

<!-- YAML
added:
- v17.4.0
- v16.14.0
changes:
- version:
- v24.0.0
- v22.17.0
pr-url: https://github.com/nodejs/node/pull/57513

Check warning on line 3082 in doc/api/stream.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
description: Marking the API stable.
-->

* `stream` {Readable|Duplex|ReadableStream}
* Returns: {boolean}

Returns whether the stream is readable.

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

<!-- YAML
Expand Down Expand Up @@ -3136,44 +3174,6 @@

Returns whether the stream has been read from or cancelled.

### `stream.isErrored(stream)`

<!-- YAML
added:
- v17.3.0
- v16.14.0
changes:
- version:
- v24.0.0
- v22.17.0
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

* `stream` {Readable|Writable|Duplex|WritableStream|ReadableStream}
* Returns: {boolean}

Returns whether the stream has encountered an error.

### `stream.isReadable(stream)`

<!-- YAML
added:
- v17.4.0
- v16.14.0
changes:
- version:
- v24.0.0
- v22.17.0
pr-url: https://github.com/nodejs/node/pull/57513
description: Marking the API stable.
-->

* `stream` {Readable|Duplex|ReadableStream}
* Returns: {boolean}

Returns whether the stream is readable.

### `stream.Readable.toWeb(streamReadable[, options])`

<!-- YAML
Expand Down
Loading