Skip to content

doc: add examples and clarify units for fs.StatFs#63585

Open
liaoyl830 wants to merge 1 commit into
nodejs:mainfrom
liaoyl830:doc/fs-statfs-docs
Open

doc: add examples and clarify units for fs.StatFs#63585
liaoyl830 wants to merge 1 commit into
nodejs:mainfrom
liaoyl830:doc/fs-statfs-docs

Conversation

@liaoyl830
Copy link
Copy Markdown

Summary

  • Add usage examples for bavail, bfree, and blocks properties showing how to calculate disk space in bytes
  • Clarify that bsize and frsize values are reported in bytes (not bits)
  • Explain statfs.type as a filesystem magic number with common examples (XFS, EXT2/3/4, tmpfs)

Fixes: #50749

- Add usage examples for bavail, bfree, and blocks properties showing
  how to calculate disk space in bytes
- Clarify that bsize and frsize values are in bytes, not bits
- Explain statfs.type as a filesystem magic number with common examples
  (XFS, EXT2/3/4, tmpfs)

Fixes: nodejs#50749
PR-URL: https://github.com/nodejs/node/pull/TBD
@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 May 26, 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