Skip to content

doc: clarify fs.StatFs property descriptions #62582

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
Herrtian wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −5
Open

doc: clarify fs.StatFs property descriptions #62582

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
15 changes: 10 additions & 5 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7929,7 +7929,8 @@ added:

* Type: {number|bigint}

Free blocks available to unprivileged users.
Free blocks available to unprivileged users. To calculate the available
space in bytes, multiply `statfs.bavail` by `statfs.frsize`.

#### `statfs.bfree`

Expand All @@ -7941,7 +7942,8 @@ added:

* Type: {number|bigint}

Free blocks in file system.
Free blocks in file system. To calculate the free space in bytes,
multiply `statfs.bfree` by `statfs.frsize`.

#### `statfs.blocks`

Expand All @@ -7965,7 +7967,7 @@ added:

* Type: {number|bigint}

Optimal transfer block size.
Optimal transfer block size, in bytes.

#### `statfs.frsize`

Expand All @@ -7975,7 +7977,8 @@ added: REPLACEME

* Type: {number|bigint}

Fundamental file system block size.
Fundamental file system block size, in bytes. This is the unit used
for block counts (`statfs.blocks`, `statfs.bfree`, `statfs.bavail`).

#### `statfs.ffree`

Expand Down Expand Up @@ -8011,7 +8014,9 @@ added:

* Type: {number|bigint}

Type of file system.
Type of file system. This is a numeric identifier corresponding to the
file system type (e.g., `0xEF53` for ext4, `0x01021997` for tmpfs on Linux).
On Windows, this value is not meaningful.

### Class: `fs.Utf8Stream`

Expand Down
Loading