doc: improve fs.StatFs documentation with examples and clarifications#62578
Open
aymanxdev wants to merge 1 commit intonodejs:mainfrom
Open
doc: improve fs.StatFs documentation with examples and clarifications#62578aymanxdev wants to merge 1 commit intonodejs:mainfrom
aymanxdev wants to merge 1 commit intonodejs:mainfrom
Conversation
Expand the descriptions for statfs.bavail, statfs.bfree, and statfs.blocks to explain how to multiply by bsize to get byte counts, and add usage examples. Expand statfs.type with an explanation of what the numeric value represents. Add a reference link for statfs.bsize to support the cross-references.
nodejs-github-bot
added
doc
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Hey, this is my first PR here.
This PR improves the documentation for the
fs.StatFsclass properties by making them more useful and informative.Summary of Changes
statfs.bavail,statfs.bfree,statfs.blocks: expand descriptionsto explain how to multiply by
bsizeto get byte counts, and addmjs/cjs usage examples
statfs.bsize: clarify the unit by adding "in bytes"statfs.type: replace the one-liner with a full explanation of whatthe numeric value represents (
f_typefromstatfs(2), platform-specific, not portable across OSes)
[statfs.bsize]reference link to support the cross-references