Skip to content

doc: updated the Class:fs filesystem documentation as it was missing … #55279

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

Closed
shrenisc wants to merge 9 commits into from
Closed

doc: updated the Class:fs filesystem documentation as it was missing … #55279

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0750024
doc: updated the Class:fs filesystem documentation as it was missing …
shrenisc Oct 5, 2024
dd678e4
Update doc/api/fs.md
shrenisc Oct 5, 2024
e9a872b
Update doc/api/fs.md
shrenisc Oct 5, 2024
78ee107
doc: updated the Class:fs filesystem documentation as it was missing …
shrenisc Oct 5, 2024
9b0a16d
Merge branch 'statfs_docs_update' of https://github.com/shrenisc/node…
shrenisc Oct 5, 2024
8b9abe6
doc: add missing examples and information to fs
shrenisc Oct 5, 2024
1e20150
doc: add missing examples and information to fs
shrenisc Oct 5, 2024
d4f5ce1
doc: add missing examples and information to fs
shrenisc Oct 5, 2024
d65ed0a
Merge branch 'nodejs:main' into statfs_docs_update
shrenisc Oct 6, 2024
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
138 changes: 136 additions & 2 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7510,6 +7510,17 @@ added:

Free blocks available to unprivileged users.

Example:
```js
const fs = require('fs');
// Calculate available space in bytes
fs.statfs('.', (err,stats) => {
const availableSpace = stats.bavail * stats.bsize;

console.log(`Available space for unprivileged users: ${availableSpace} bytes`);
});
```

#### `statfs.bfree`

<!-- YAML
Expand All @@ -7522,6 +7533,17 @@ added:

Free blocks in file system.

Example:
```js
const fs = require('fs');
// Calculate total free space in bytes using bfree and bsize
fs.statfs('.', (err,stats) => {
const totalFreeSpace = stats.bfree * stats.bsize;

console.log(`Total free space (including reserved blocks): ${totalFreeSpace} bytes`);
});
```

#### `statfs.blocks`

<!-- YAML
Expand All @@ -7534,6 +7556,17 @@ added:

Total data blocks in file system.

Example:
```js
const fs = require('fs');
// Get the total number of blocks
fs.statfs('.', (err,stats) => {
const totalBlocks = stats.blocks;

console.log(`Total number of blocks on the filesystem: ${totalBlocks}`);
});
```

#### `statfs.bsize`

<!-- YAML
Expand All @@ -7544,7 +7577,7 @@ added:

* {number|bigint}

Optimal transfer block size.
Optimal transfer block size (measured in bytes).

#### `statfs.ffree`

Expand All @@ -7570,6 +7603,17 @@ added:

Total file nodes in file system.

Example:
```js
const fs = require('fs');
fs.statfs('.', (err, stats) => {
// Calculate total free space in bytes using bfree and bsize
const totalFreeSpace = stats.bfree * stats.bsize;

console.log(`Total free space (including reserved blocks): ${totalFreeSpace} bytes`);
});
```

#### `statfs.type`

<!-- YAML
Expand All @@ -7580,7 +7624,97 @@ added:

* {number|bigint}

Type of file system.
Type of file system, represented by the decimal form of the file's magic number.

Here are some common filesystems and their magic numbers:
<table>
<tr>
<th>Filesystem</th>
<th>Magic Number (Hexadecimal)</th>
<th>Description</th>
</tr>
<tr>
<td>ext2</td>
<td>0xEF53</td>
<td>Second Extended File System (Linux)</td>
</tr>
<tr>
<td>ext3</td>
<td>0xEF53</td>
<td>Third Extended File System (Linux)</td>
</tr>
<tr>
<td>ext4</td>
<td>0xEF53</td>
<td>Fourth Extended File System (Linux)</td>
</tr>
<tr>
<td>Btrfs</td>
<td>0x9123683E</td>
<td>B-tree File System (Linux)</td>
</tr>
<tr>
<td>XFS</td>
<td>0x58465342</td>
<td>X File System (Linux)</td>
</tr>
<tr>
<td>FAT</td>
<td>0xadf5</td>
<td>File Allocation Table (legacy FAT)</td>
</tr>
<tr>
<td>NFS</td>
<td>0x6969</td>
<td>Network File System</td>
</tr>
<tr>
<td>ISO 9660</td>
<td>0x9660</td>
<td>CD-ROM File System</td>
</tr>
<tr>
<td>SMB/CIFS</td>
<td>0xFF534D42</td>
<td>Server Message Block / Common Internet File System</td>
</tr>
<tr>
<td>JFFS2</td>
<td>0x72B6</td>
<td>Journaling Flash File System</td>
</tr>
<tr>
<td>UDF</td>
<td>0x15013346</td>
<td>Universal Disk Format</td>
</tr>
<tr>
<td>procfs</td>
<td>0x9fa0</td>
<td>Process File System</td>
</tr>
<tr>
<td>sysfs</td>
<td>0x62656572</td>
<td>System File System</td>
</tr>
<tr>
<td>tmpfs</td>
<td>0x01021994</td>
<td>Temporary File System</td>
</tr>
<tr>
<td>cgroupfs</td>
<td>0x27e0eb</td>
<td>Control Group File System</td>
</tr>
<tr>
<td>ramfs</td>
<td>0x858458f6</td>
<td>RAM File System</td>
</tr>
</table>

Comment on lines +7629 to +7717
Copy link
Member

@avivkeller avivkeller Oct 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of a table, is there a wikipage or something that users can be referred to?

Copy link
Author

@shrenisc shrenisc Oct 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found a Linux Manual page which lists these filesystems but I am unsure whether we can link it here. Also, they only list Linux filesystems and miss out on the popular NTFS, NFS etc.


### Class: `fs.WriteStream`

Expand Down