Improve documentation for fs.statfs with detailed descriptions and examples #57062
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
jasnell
reviewed
Feb 15, 2025
doc/api/fs.md
Outdated
| @@ -4451,28 +4451,62 @@ Stats { | |||
| } | |||
| ``` | |||
|
|
|||
| ### `fs.statfs(path[, options], callback)` | |||
| ### fs.statfs(path[, options], callback) | |||
There was a problem hiding this comment.
Not sure why you removed the backticks from the header
Suggested change
| ### fs.statfs(path[, options], callback) | |
| ### `fs.statfs(path[, options], callback)` |
There was a problem hiding this comment.
Thanks for the feedback! I’ve restored the backticks and fixed the parameter formatting for consistency. Please review the changes.
jasnell
reviewed
Feb 15, 2025
doc/api/fs.md
Outdated
Comment on lines
4458
to
4476
| #### **Parameters** | ||
| - `path` **{string|Buffer|URL}** - The file or directory path to query. | ||
| - `options` **{Object}** *(Optional)* | ||
| - `bigint` **{boolean}** - If `true`, numeric values in the returned `fs.StatFs` object will be `BigInt` instead of `number`. Default: `false`. | ||
| - `callback` **{Function}** - Function called with the result: | ||
| - `err` **{Error}** - If an error occurs, contains error details. | ||
| - `stats` **{fs.StatFs}** - Contains file system statistics. | ||
|
|
||
| #### **Returned `fs.StatFs` Object Properties** | ||
| The returned `fs.StatFs` object contains: | ||
| - `type` **{number}** - The type of filesystem. | ||
| - `bsize` **{number}** - Optimal transfer block size. | ||
| - `blocks` **{number|BigInt}** - Total data blocks in the filesystem. | ||
| - `bfree` **{number|BigInt}** - Free blocks available to unprivileged users. | ||
| - `bavail` **{number|BigInt}** - Free blocks for privileged users. | ||
| - `files` **{number|BigInt}** - Total file nodes in the filesystem. | ||
| - `ffree` **{number|BigInt}** - Free file nodes. | ||
| - `fsid` **{number}** - File system ID. | ||
| - `namemax` **{number}** - Maximum filename length. |
There was a problem hiding this comment.
This does not align with the formatting for everything else. The #### headers for parameters is unnecessary, as are the ** around the type indicators.
There was a problem hiding this comment.
Thanks for the feedback! I’ve restored the backticks and fixed the parameter formatting for consistency. Please review the changes.
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.
Summary
This PR enhances the documentation for
fs.statfsby:fs.StatFsobject.bigint: trueoptions.Changes Made
doc/api/fs.mdwith improved descriptions.Why?
Related Issue
Closes nodejs/node#50749
Let me know if any additional improvements are needed! 🚀