Skip to content
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

Jump to bottom

Docs: fixes filehandle.read docs to show default buffer value length as 0 #39163

Closed
wants to merge 1 commit into from
Closed

Docs: fixes filehandle.read docs to show default buffer value length as 0 #39163

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 4 additions & 8 deletions doc/api/fs.md
View file
Open in desktop
Expand Up @@ -268,9 +268,7 @@ added: v10.0.0
* `buffer` {Buffer|TypedArray|DataView} A buffer that will be filled with the
file data read.
* `offset` {integer} The location in the buffer at which to start filling.
**Default:** `0`
* `length` {integer} The number of bytes to read. **Default:**
`buffer.byteLength`
* `length` {integer} The number of bytes to read.
* `position` {integer} The location where to begin reading data from the
file. If `null`, data will be read from the current file position, and
the position will be updated. If `position` is an integer, the current
Expand Down Expand Up @@ -2746,11 +2744,9 @@ changes:

* `fd` {integer}
* `buffer` {Buffer|TypedArray|DataView} The buffer that the data will be
written to. **Default:** `Buffer.alloc(16384)`
* `offset` {integer} The position in `buffer` to write the data to. **Default:**
`0`
* `length` {integer} The number of bytes to read. **Default:**
`buffer.byteLength`
written to.
* `offset` {integer} The position in `buffer` to write the data to.
* `length` {integer} The number of bytes to read.
* `position` {integer|bigint} Specifies where to begin reading from in the
file. If `position` is `null` or `-1 `, data will be read from the current
file position, and the file position will be updated. If `position` is an
Expand Down