Skip to content

doc: clarify fs.StatFs property descriptions#62582

Open
Herrtian wants to merge 1 commit intonodejs:mainfrom
Herrtian:doc-statfs-improvements
Open

doc: clarify fs.StatFs property descriptions#62582
Herrtian wants to merge 1 commit intonodejs:mainfrom
Herrtian:doc-statfs-improvements

Conversation

@Herrtian
Copy link
Copy Markdown

@Herrtian Herrtian commented Apr 4, 2026

Summary

Improves the documentation for the fs.StatFs class properties.

Changes:

  • statfs.bsize: Specify that the unit is bytes
  • statfs.frsize: Clarify that this is the unit used for block counts (blocks, bfree, bavail)
  • statfs.bavail: Add note on how to calculate available space in bytes (bavail * frsize)
  • statfs.bfree: Add note on how to calculate free space in bytes (bfree * frsize)
  • statfs.type: Explain the numeric file system type identifier with examples, note platform differences

Fixes: #50749

- statfs.bsize: specify unit is bytes
- statfs.frsize: clarify it's the unit for block counts
- statfs.bavail: add note on calculating available space in bytes
- statfs.bfree: add note on calculating free space in bytes
- statfs.type: explain the numeric identifier and platform differences

Fixes: nodejs#50749
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Apr 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing documentation in fs.StatFs

2 participants