Skip to content

feat: make fs.read params optional #31402

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

Closed
lholmquist wants to merge 17 commits into from
Closed

feat: make fs.read params optional #31402

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
95f03ef
feat: make fs.read params optional
lholmquist Jan 16, 2020
478d2f0
squash: doc updates
lholmquist Jan 22, 2020
10d3902
squash: adding in test
lholmquist Jan 22, 2020
dfdd3b4
squash: better use of destructoring
lholmquist Jan 22, 2020
cf320a0
squash: refactor.
lholmquist Feb 11, 2020
418b6fd
squash: Update doc/api/fs.md
lholmquist Feb 12, 2020
e3835c2
squash: Update doc/api/fs.md
lholmquist Feb 12, 2020
128aeab
squash: reverting some doc updates
lholmquist Feb 12, 2020
2c5d3e7
squash: Update doc/api/fs.md
lholmquist Feb 13, 2020
6433727
squash: Update doc/api/fs.md
lholmquist Feb 13, 2020
3923975
squash: add test for promise based
lholmquist Feb 13, 2020
f6f01b6
squash: add defaults to filehandler.read docs
lholmquist Feb 14, 2020
55a2356
squash: add the use case for an optional options object
lholmquist Feb 26, 2020
f86bdc1
squash: add test for optional options option
lholmquist Feb 26, 2020
a4c3763
squash: a little more doc update
lholmquist Feb 26, 2020
e321b88
squash: doc linting
lholmquist Feb 26, 2020
cb8c0ef
squash: combine tests and add another test that passes options
lholmquist Mar 6, 2020
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
Prev Previous commit
Next Next commit
squash: reverting some doc updates
  • Loading branch information
@lholmquist
lholmquist committed Feb 12, 2020
commit 128aeaba03fa3611466e2446d62e2da05c72f7a3
14 changes: 5 additions & 9 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2716,14 +2716,10 @@ Returns an integer representing the file descriptor.
For detailed information, see the documentation of the asynchronous version of
this API: [`fs.open()`][].

## `fs.read(fd, [buffer[, [offset[, length[, position]]]], callback)`
## `fs.read(fd, buffer, offset, length, position, callback)`
<!-- YAML
added: v0.0.2
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/31402
description: Buffer, offset, length and position parameters
are now optional
- version: v10.10.0
pr-url: https://github.com/nodejs/node/pull/22150
description: The `buffer` parameter can now be any `TypedArray`, or a
Expand All @@ -2737,10 +2733,10 @@ changes:
-->

* `fd` {integer}
* `buffer` {Buffer|TypedArray|DataView} **Default:** `Buffer.alloc(16384)`
* `offset` {integer} **Default:** `0`
* `length` {integer} **Default:** `buffer.length`
* `position` {integer} **Default:** `null`
* `buffer` {Buffer|TypedArray|DataView}
* `offset` {integer}
* `length` {integer}
* `position` {integer}
* `callback` {Function}
* `err` {Error}
* `bytesRead` {integer}
Expand Down