Missing documentation in fs.StatFs

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?

Hi I would like to work on this issue, can this be assigned to me? TIA!

Hi I would like to work on this issue, can this be assigned to me? TIA!

Go for it!

Hi there, I do not know if this was already solved, but I would like to be assigned to it please.

Hi, can I work on this issue ?

Hi, I would like to work on this issue

Hii, can I work on this issue?

No need to ask permission, just open a PR :-)

doc: improve fs.StatFs property descriptions

doc: improve fs.StatFs documentation

doc: improve `fs.StatFs` properties descriptions

Navigation Menu

Repository navigation

Missing documentation in `fs.StatFs` #50749

Affected URL(s)

Description of the problem

39 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Missing documentation in fs.StatFs #50749

Description

Affected URL(s)

Description of the problem

Activity

M-Faheem-Khan commented on Nov 18, 2023

juanarbol commented on Dec 13, 2023

JuanJFrontDev commented on Dec 27, 2023

zeffanine-aimen commented on Apr 15, 2024

taiwo2 commented on Oct 1, 2024

iamanujkumar commented on Oct 1, 2024

avivkeller commented on Oct 5, 2024

39 remaining items

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

Missing documentation in `fs.StatFs` #50749