Skip to content

Commit e8be132

Browse files
authored
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 9041ad0 commit e8be132

3 files changed

Lines changed: 105 additions & 57 deletions

File tree

doc/api/fs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@ added:
400400
reached, whichever comes first. **Default:** read until EOF.
401401
* `chunkSize` {number} Size in bytes of the buffer allocated for each
402402
read operation. **Default:** `131072` (128 KB).
403-
* Returns: {AsyncIterable\<Uint8Array\[]>}
403+
* Returns: {AsyncIterable} whose chunks fulfill with {Uint8Array\[]}
404404
405405
Return the file contents as an async iterable using the
406406
[`node:stream/iter`][] pull model. Reads are performed in `chunkSize`-byte
@@ -475,7 +475,7 @@ added:
475475
iterator. **Default:** read until EOF.
476476
* `chunkSize` {number} Size in bytes of the buffer allocated for each
477477
read operation. **Default:** `131072` (128 KB).
478-
* Returns: {Iterable\<Uint8Array\[]>}
478+
* Returns: {Iterable} whose chunks return {Uint8Array\[]}
479479
480480
Synchronous counterpart of [`filehandle.pull()`][]. Returns a sync iterable
481481
that reads the file using synchronous I/O on the main thread. Reads are
@@ -9330,7 +9330,7 @@ the file contents.
93309330
[`minimatch`]: https://github.com/isaacs/minimatch
93319331
[`node:stream/iter`]: stream_iter.md
93329332
[`statfs.bsize`]: #statfsbsize
9333-
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer
9333+
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
93349334
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
93359335
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
93369336
[`util.promisify()`]: util.md#utilpromisifyoriginal

0 commit comments

Comments
 (0)