doc: add missing api fs cjs code snippet #59843
Open
Conversation
This file contains hidden or 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
jasnell
approved these changes
Sep 13, 2025
aduh95
added
author ready
There's non toggle button at every piece of code in file system doc. This would be of no use if the developer has not imported the fs module in every piece of code just like in any other docs. Fixes: nodejs#59769 Refs: https://nodejs.org/docs/latest/api/fs.html
aduh95
force-pushed
the
doc/add-missing-api-fs-cjs-code-snippet
branch
from
66768f0 to
96ac742
Compare
aduh95
reviewed
Dec 16, 2025
| }); | ||
| // This method is *CORRECT*: | ||
| import { sep } from 'node:path'; |
Contributor
There was a problem hiding this comment.
Suggested change
| import { sep } from 'node:path'; | |
| const { sep } = require('node:path'); |
aduh95
reviewed
Dec 16, 2025
| const { readFile } = require('node:fs'); | ||
|
|
||
| readFile('/etc/passwd', 'utf8', callback); | ||
| `` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
There's non toggle button at every piece of code in file system doc. This would be of no use if the developer has not imported the fs module in every piece of code just like in any other docs.
Fixes: #59769
Refs: https://nodejs.org/docs/latest/api/fs.html