doc: improve fs.StatFs property documentation#63548
Open
AliMahmoudDev wants to merge 1 commit into
Open
Conversation
Fixes nodejs#50749 - statfs.bsize: clarify the unit is bytes (not bits) - statfs.bavail: add example showing how to calculate available size in bytes (bsize * bavail) - statfs.bfree: add example showing how to calculate free size in bytes (bsize * bfree) - statfs.type: explain that it is a numeric filesystem identifier and provide common examples (ext4, FAT)
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.
Summary
Fixes #50749
Improves the documentation for
fs.StatFsclass properties to address the following gaps:Changes
statfs.bsize— Added clarification that the value is in bytes (not bits). Also added guidance that this should be multiplied with block counts (bavail,bfree) to calculate byte sizes.statfs.bavail— Added an example showing how to calculate available disk space in bytes:statfs.bsize * statfs.bavailstatfs.bfree— Added an example showing how to calculate free disk space in bytes:statfs.bsize * statfs.bfreestatfs.type— Explained that the value is a numeric identifier corresponding to the filesystem type (e.g.,0xEF53for ext4,0x4D44for FAT), and that values are platform-specific.