Skip to content

doc: remove unsupported syntax from stream_iter.md #64649

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

Open
aduh95 wants to merge 2 commits into
base: main
Choose a base branch
from
+129 −81
Open

doc: remove unsupported syntax from stream_iter.md #64649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40bd810
doc: remove unsupported syntax from `stream_iter.md`
aduh95 Jul 21, 2026
53a84be
fixup! doc: remove unsupported syntax from `stream_iter.md`
aduh95 Jul 21, 2026
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
6 changes: 3 additions & 3 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ added:
reached, whichever comes first. **Default:** read until EOF.
* `chunkSize` {number} Size in bytes of the buffer allocated for each
read operation. **Default:** `131072` (128 KB).
* Returns: {AsyncIterable\<Uint8Array\[]>}
* Returns: {AsyncIterable} whose chunks fulfill with {Uint8Array\[]}

Return the file contents as an async iterable using the
[`node:stream/iter`][] pull model. Reads are performed in `chunkSize`-byte
Expand Down Expand Up @@ -475,7 +475,7 @@ added:
iterator. **Default:** read until EOF.
* `chunkSize` {number} Size in bytes of the buffer allocated for each
read operation. **Default:** `131072` (128 KB).
* Returns: {Iterable\<Uint8Array\[]>}
* Returns: {Iterable} whose chunks return {Uint8Array\[]}

Synchronous counterpart of [`filehandle.pull()`][]. Returns a sync iterable
that reads the file using synchronous I/O on the main thread. Reads are
Expand Down Expand Up @@ -9330,7 +9330,7 @@ the file contents.
[`minimatch`]: https://github.com/isaacs/minimatch
[`node:stream/iter`]: stream_iter.md
[`statfs.bsize`]: #statfsbsize
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
[`util.promisify()`]: util.md#utilpromisifyoriginal
Expand Down
Loading
Loading