doc: clarify behaviour of writeFile(fd) #27282
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
lpinca
approved these changes
Apr 17, 2019
doc/api/fs.md
Outdated
| When `file` is a file descriptor, the behaviour is almost identical to directly | ||
| calling [`fs.write()`][] like: | ||
| ```javascript | ||
| fs.write(fd, Buffer.from(options.encoding), callback); |
There was a problem hiding this comment.
Buffer.from(options.encoding) seems a bit confusing here. Is something missing?
| @@ -3615,14 +3619,33 @@ It is unsafe to use `fs.writeFile()` multiple times on the same file without | |||
| waiting for the callback. For this scenario, [`fs.createWriteStream()`][] is | |||
| recommended. | |||
|
|
|||
| ### File Descriptors | |||
| 1. Any specified file descriptor has to support writing. | |||
There was a problem hiding this comment.
Are 1 and 2 skipped intentionally?
There was a problem hiding this comment.
Yes, now, the difference from fs.write() is described, rather than the previous more complicated way of describing the fd behaviour.
There was a problem hiding this comment.
3 was skipped as well -- which makes the entire previous list being replaced.
This is a continuing source of confusion, attempt to make it even more clear. Fixes: nodejs#24923
sam-github
force-pushed
the
clarify-writefile
branch
from
881b78c
to
e9f2aff
Compare
|
@vsemozhetbyt PTAL |
vsemozhetbyt
approved these changes
Apr 24, 2019
vsemozhetbyt
added
the
author ready
sam-github
added a commit
to sam-github/node
that referenced
this pull request
Apr 24, 2019
This is a continuing source of confusion, attempt to make it even more clear. Fixes: nodejs#24923 PR-URL: nodejs#27282 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
|
Landed in a763de1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a continuing source of confusion, attempt to make it even more
clear.
Fixes: #24923
Checklist