Skip to content

Commit df5b1e1

Browse files
committed
doc: remove unsupported syntax from stream_iter.md
Signed-off-by: Antoine du Hamel <duhamelantoine1995@gmail.com> PR-URL: #64649 Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Aviv Keller <me@aviv.sh>
1 parent ec67e24 commit df5b1e1

3 files changed

Lines changed: 105 additions & 56 deletions

File tree

doc/api/fs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ added: v25.9.0
399399
reached, whichever comes first. **Default:** read until EOF.
400400
* `chunkSize` {number} Size in bytes of the buffer allocated for each
401401
read operation. **Default:** `131072` (128 KB).
402-
* Returns: {AsyncIterable\<Uint8Array\[]>}
402+
* Returns: {AsyncIterable} whose chunks fulfill with {Uint8Array\[]}
403403
404404
Return the file contents as an async iterable using the
405405
[`node:stream/iter`][] pull model. Reads are performed in `chunkSize`-byte
@@ -473,7 +473,7 @@ added: v25.9.0
473473
iterator. **Default:** read until EOF.
474474
* `chunkSize` {number} Size in bytes of the buffer allocated for each
475475
read operation. **Default:** `131072` (128 KB).
476-
* Returns: {Iterable\<Uint8Array\[]>}
476+
* Returns: {Iterable} whose chunks return {Uint8Array\[]}
477477
478478
Synchronous counterpart of [`filehandle.pull()`][]. Returns a sync iterable
479479
that reads the file using synchronous I/O on the main thread. Reads are
@@ -9315,7 +9315,7 @@ the file contents.
93159315
[`minimatch`]: https://github.com/isaacs/minimatch
93169316
[`node:stream/iter`]: stream_iter.md
93179317
[`statfs.bsize`]: #statfsbsize
9318-
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer
9318+
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
93199319
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
93209320
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
93219321
[`util.promisify()`]: util.md#utilpromisifyoriginal

0 commit comments

Comments
 (0)