doc: add ESM and CommonJS examples in fs documentation
#52207
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
Signed-off-by: Tierney Cyren <[email protected]>
Signed-off-by: Tierney Cyren <[email protected]>
Signed-off-by: Tierney Cyren <[email protected]>
nodejs-github-bot
added
doc
Signed-off-by: Tierney Cyren <[email protected]>
bnb
commented
Mar 25, 2024
Comment on lines
+906
to
+907
| await access('/etc/passwd', constants.R_OK | constants.W_OK); | ||
| console.log('can access'); |
There was a problem hiding this comment.
This doesn't seem right to me, actually. Specifically, I think the console.log() can trigger despite the access failing.
Signed-off-by: Tierney Cyren <[email protected]>
aduh95
reviewed
Mar 26, 2024
| import { chmod } from 'node:fs/promises'; | ||
|
|
||
| try { | ||
| await chmod('my_file.txt', 0o775).then(console.log('The permissions for file "my_file.txt" have been changed!')); |
There was a problem hiding this comment.
IMO it's much more readable as two separate expressions
Suggested change
| await chmod('my_file.txt', 0o775).then(console.log('The permissions for file "my_file.txt" have been changed!')); | |
| await chmod('my_file.txt', 0o775); | |
| console.log('The permissions for file "my_file.txt" have been changed!'); |
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 PR adds a handful of code examples to
fsmethods where code examples were either entirely omitted or were only available for ESM. This includes code examples for bothfsPromisesandfs, trying to keep them in lockstep.This includes a code example for a method,
fs.chown, that was added in Node.js v0.1.97 and seemingly has never had a code example. I've added ESM and CommonJS examples for both the normalfsandfsPromisesversions of this method.