Missing documentation in `fs.StatFs`

Why this is a good first issue

Documentation improvements with clear examples needed for fs.StatFs properties.

AI Summary

The issue requests better documentation for fs.StatFs properties including examples for bsize, bavail, bfree, blocks, files, and clarification on type. The scope is limited to documentation improvements with clear examples, making it a good candidate for contributors familiar with Node.js filesystem operations.

Issue Description

Affected URL(s)

https://nodejs.org/api/fs.html#class-fsstatfs

Description of the problem

statfs.bsize fails to mention if the size is reported in bits or bytes

While statfs.bavail and statfs.bfree can be used to calculate available and free space, it would be appropriate to put an example on how to use them Example:

import { statfs } from "fs/promises"
const statsfs = await statfs("/tmp")
const available_bits_or_bytes_not_documented = statsfs.bsize * statsfs.bavail

Similarly, statfs.blocks and statfs.files would strongly benefit from an example
What's statfs.type and why is it a number?

GitHub Labels

docfsgood first issue