doc: improve fs.StatFs field descriptions and add usage examples#61965
Open
turanalmammadov wants to merge 1 commit intonodejs:mainfrom
Open
doc: improve fs.StatFs field descriptions and add usage examples#61965turanalmammadov wants to merge 1 commit intonodejs:mainfrom
turanalmammadov wants to merge 1 commit intonodejs:mainfrom
Conversation
Addresses the gaps reported in nodejs#50749: * - explicitly state the unit is bytes, which is non-obvious because the other fields are measured in *blocks*. * / - explain the difference between the two (superuser-reserved blocks), and add a code example showing how to multiply by bsize to get available bytes. * - add a code example that computes total, used, and available space in gigabytes from the three block-count fields. * / - explain that these measure inodes, not bytes; add a code example showing how to calculate inode usage. * - explain that the value is a numeric OS-level file system identifier; point to the canonical header files for Linux (<linux/magic.h>) and macOS (<sys/mount.h>); note that the value is platform-specific and always 0 on Windows; add a code snippet that prints the value in hex for easier cross-referencing. All examples are provided in both ESM and CJS variants where applicable. Fixes: nodejs#50749 Co-authored-by: Cursor <cursoragent@cursor.com>
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.
Fixes #50749
What is improved?
The
fs.StatFsdocumentation was sparse and left several questions unanswered for users:statfs.bsizebXxxfields are block counts that must be multiplied bybsizeto obtain byte values. Includes a short code snippet.statfs.bavail/statfs.bfreebfreeincludes superuser-reserved blocks whilebavailis what unprivileged processes can actually use. Adds abavail * bsizeexample showing how to compute available space in GB.statfs.blocksstatfs.statfs.files/statfs.ffreestatfs.typef_typein the POSIXstatvfsstructure. Points to the canonical headers for each OS (<linux/magic.h>,<sys/mount.h>), notes the Windows behaviour (always0), and adds a hex-printing code example.Code examples
All examples are included in both ESM (
import) and CJS (require) variants where the length warrants it, following the existing style in thefsdocumentation.Made with Cursor