Skip to content

Commit 1519b75

Browse files
aduh95targos
authored andcommitted
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 d8f3f64 commit 1519b75

File tree

1 file changed

+38
-34
lines changed

1 file changed

+38
-34
lines changed

doc/api/stream.md

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

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

3043+
### `stream.isErrored(stream)`
3044+
3045+
<!-- YAML
3046+
added:
3047+
- v17.3.0
3048+
- v16.14.0
3049+
changes:
3050+
- version:
3051+
- v24.0.0
3052+
- v22.17.0
3053+
pr-url: https://github.com/nodejs/node/pull/57513
3054+
description: Marking the API stable.
3055+
-->
3056+
3057+
* `stream` {Readable|Writable|Duplex|WritableStream|ReadableStream}
3058+
* Returns: {boolean}
3059+
3060+
Returns whether the stream has encountered an error.
3061+
3062+
### `stream.isReadable(stream)`
3063+
3064+
<!-- YAML
3065+
added:
3066+
- v17.4.0
3067+
- v16.14.0
3068+
changes:
3069+
- version:
3070+
- v24.0.0
3071+
- v22.17.0
3072+
pr-url: https://github.com/nodejs/node/pull/57513
3073+
description: Marking the API stable.
3074+
-->
3075+
3076+
* `stream` {Readable|Duplex|ReadableStream}
3077+
* Returns: {boolean}
3078+
3079+
Returns whether the stream is readable.
3080+
30433081
### `stream.Readable.from(iterable[, options])`
30443082

30453083
<!-- YAML
@@ -3122,40 +3160,6 @@ changes:
31223160

31233161
Returns whether the stream has been read from or cancelled.
31243162

3125-
### `stream.isErrored(stream)`
3126-
3127-
<!-- YAML
3128-
added:
3129-
- v17.3.0
3130-
- v16.14.0
3131-
changes:
3132-
- version: v24.0.0
3133-
pr-url: https://github.com/nodejs/node/pull/57513
3134-
description: Marking the API stable.
3135-
-->
3136-
3137-
* `stream` {Readable|Writable|Duplex|WritableStream|ReadableStream}
3138-
* Returns: {boolean}
3139-
3140-
Returns whether the stream has encountered an error.
3141-
3142-
### `stream.isReadable(stream)`
3143-
3144-
<!-- YAML
3145-
added:
3146-
- v17.4.0
3147-
- v16.14.0
3148-
changes:
3149-
- version: v24.0.0
3150-
pr-url: https://github.com/nodejs/node/pull/57513
3151-
description: Marking the API stable.
3152-
-->
3153-
3154-
* `stream` {Readable|Duplex|ReadableStream}
3155-
* Returns: {boolean}
3156-
3157-
Returns whether the stream is readable.
3158-
31593163
### `stream.Readable.toWeb(streamReadable[, options])`
31603164

31613165
<!-- YAML

0 commit comments

Comments
 (0)