Skip to content

Commit dfefca4

Browse files
committed
doc: address review feedback on fs.StatFs descriptions
- Simplify bsize description per POSIX definition (optimal transfer block size, in bytes) - Change 'On Windows' to 'On some platforms' for statfs.type since libuv also returns 0 on Solaris, OpenBSD, NetBSD, Haiku, and QNX
1 parent ad50ab2 commit dfefca4

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

doc/api/fs.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7739,8 +7739,7 @@ added:
77397739
77407740
* Type: {number|bigint}
77417741
7742-
The optimal transfer block size in bytes. This value represents the fundamental
7743-
block size used by the file system for allocating and transferring data.
7742+
Optimal transfer block size, in bytes.
77447743
77457744
#### `statfs.ffree`
77467745
@@ -7782,7 +7781,7 @@ added:
77827781
77837782
A numeric identifier for the file system type. This value is a filesystem magic
77847783
number set by the operating system kernel, such as `0xEF53` for ext4 or
7785-
`0x01021994` for tmpfs on Linux. On Windows, this value is `0`.
7784+
`0x01021994` for tmpfs on Linux. On some platforms, this value is `0`.
77867785
77877786
### Class: `fs.Utf8Stream`
77887787

0 commit comments

Comments
 (0)