Skip to content

doc: improve fs.StatFs property documentation #63548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AliMahmoudDev wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −4
Open

doc: improve fs.StatFs property documentation #63548

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8002,7 +8002,8 @@ added:

* Type: {number|bigint}

Free blocks available to unprivileged users.
Free blocks available to unprivileged users. Multiply by `statfs.bsize` to get
the available size in bytes: `statfs.bsize * statfs.bavail`.

#### `statfs.bfree`

Expand All @@ -8014,7 +8015,8 @@ added:

* Type: {number|bigint}

Free blocks in file system.
Free blocks in the file system. Multiply by `statfs.bsize` to get
the free size in bytes: `statfs.bsize * statfs.bfree`.

#### `statfs.blocks`

Expand All @@ -8038,7 +8040,8 @@ added:

* Type: {number|bigint}

Optimal transfer block size.
Optimal transfer block size **in bytes**. Multiply this by block counts
(e.g., `statfs.bavail` or `statfs.bfree`) to calculate sizes in bytes.

#### `statfs.frsize`

Expand Down Expand Up @@ -8086,7 +8089,10 @@ added:

* Type: {number|bigint}

Type of file system.
Type of file system. The value is a numeric identifier corresponding to the
file system type (e.g., `0xEF53` for ext4, `0x4D44` for FAT). These values
are platform-specific and derived from the `f_type` field of `statvfs`/`statfs`
on POSIX systems, or equivalent platform APIs.

### Class: `fs.Utf8Stream`

Expand Down
Loading