Skip to content

Commit fa5818e

Browse files
committed
doc: fix stream.md section order
For some reason, `stream.isErrored` and `stream.isReadable` sections were in between `stream.Readable` static methods sections. PR-URL: #58811 Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com> Reviewed-By: Ethan Arrowood <ethan@arrowood.dev> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 79428d8 commit fa5818e

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

doc/api/stream.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3026,6 +3026,40 @@ console.log(res); // prints 'HELLOWORLD'
30263026

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

3029+
### `stream.isErrored(stream)`
3030+
3031+
<!-- YAML
3032+
added:
3033+
- v17.3.0
3034+
- v16.14.0
3035+
changes:
3036+
- version: v22.17.0
3037+
pr-url: https://github.com/nodejs/node/pull/57513
3038+
description: Marking the API stable.
3039+
-->
3040+
3041+
* `stream` {Readable|Writable|Duplex|WritableStream|ReadableStream}
3042+
* Returns: {boolean}
3043+
3044+
Returns whether the stream has encountered an error.
3045+
3046+
### `stream.isReadable(stream)`
3047+
3048+
<!-- YAML
3049+
added:
3050+
- v17.4.0
3051+
- v16.14.0
3052+
changes:
3053+
- version: v22.17.0
3054+
pr-url: https://github.com/nodejs/node/pull/57513
3055+
description: Marking the API stable.
3056+
-->
3057+
3058+
* `stream` {Readable|Duplex|ReadableStream}
3059+
* Returns: {boolean}
3060+
3061+
Returns whether the stream is readable.
3062+
30293063
### `stream.Readable.from(iterable[, options])`
30303064

30313065
<!-- YAML
@@ -3108,40 +3142,6 @@ changes:
31083142

31093143
Returns whether the stream has been read from or cancelled.
31103144

3111-
### `stream.isErrored(stream)`
3112-
3113-
<!-- YAML
3114-
added:
3115-
- v17.3.0
3116-
- v16.14.0
3117-
changes:
3118-
- version: v22.17.0
3119-
pr-url: https://github.com/nodejs/node/pull/57513
3120-
description: Marking the API stable.
3121-
-->
3122-
3123-
* `stream` {Readable|Writable|Duplex|WritableStream|ReadableStream}
3124-
* Returns: {boolean}
3125-
3126-
Returns whether the stream has encountered an error.
3127-
3128-
### `stream.isReadable(stream)`
3129-
3130-
<!-- YAML
3131-
added:
3132-
- v17.4.0
3133-
- v16.14.0
3134-
changes:
3135-
- version: v22.17.0
3136-
pr-url: https://github.com/nodejs/node/pull/57513
3137-
description: Marking the API stable.
3138-
-->
3139-
3140-
* `stream` {Readable|Duplex|ReadableStream}
3141-
* Returns: {boolean}
3142-
3143-
Returns whether the stream is readable.
3144-
31453145
### `stream.Readable.toWeb(streamReadable[, options])`
31463146

31473147
<!-- YAML

0 commit comments

Comments
 (0)