Skip to content

[v14.x backport] fs: fix write methods param validation and docs #42603

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
aduh95 wants to merge 2 commits into from
Closed

[v14.x backport] fs: fix write methods param validation and docs #42603

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
808e8b1
doc: fix documentation of `FileHandle.prototype.appendFile`
aduh95 Apr 3, 2022
18ac4af
fs: fix write methods param validation and docs
LiviaMedeiros Apr 4, 2022
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
Next Next commit
doc: fix documentation of FileHandle.prototype.appendFile 
PR-URL: #42588
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
  • Loading branch information
@aduh95
aduh95 committed Apr 4, 2022
commit 808e8b10a1e8b26d6ee3d699c6fa92bf482b5408
15 changes: 14 additions & 1 deletion doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,22 @@ close {FileHandle}s. Node.js may change this behavior in the future.
#### `filehandle.appendFile(data[, options])`
<!-- YAML
added: v10.0.0
changes:
- version: v14.18.0
pr-url: https://github.com/nodejs/node/pull/37490
description: The `data` argument supports `AsyncIterable`, `Iterable` and `Stream`.
- version: v14.12.0
pr-url: https://github.com/nodejs/node/pull/34993
description: The `data` parameter will stringify an object with an
explicit `toString` function.
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/31030
description: The `data` parameter won't coerce unsupported input to
strings anymore.
-->

* `data` {string|Buffer|TypedArray|DataView}
* `data` {string|Buffer|TypedArray|DataView|Object|AsyncIterable|Iterable
|Stream}
* `options` {Object|string}
* `encoding` {string|null} **Default:** `'utf8'`
* Returns: {Promise} Fulfills with `undefined` upon success.
Expand Down