doc: updated the Class:fs filesystem documentation as it was missing … #55279
+166
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…information and examples Defined the return type for statfs.bsize. Added examples for statfs.bavail, statfs.bfree, statfs.blocks and statfs.files for clarity. Cleared the air on why statfs.type returns a int|bigint value. Fixes: nodejs#50749
nodejs-github-bot
added
doc
RedYetiDev
reviewed
Oct 5, 2024
Comment on lines
+7513
to
+7529
| Example: | ||
| ```mjs | ||
| const fs = require('fs'); | ||
|
|
||
| // Specify the path you want to check (like '/' or 'C:/'). | ||
| fs.statfs('.', (err, stats) => { | ||
| if (err) { | ||
| console.error('Error reading file system stats:', err); | ||
| return; | ||
| } | ||
|
|
||
| // Calculate available space in bytes | ||
| const availableSpace = stats.bavail * stats.bsize; | ||
|
|
||
| console.log(`Available space for unprivileged users: ${availableSpace} bytes`); | ||
| }); | ||
| ``` |
There was a problem hiding this comment.
This is commonjs, but the mjs code block is used
Comment on lines
+7513
to
+7529
| Example: | ||
| ```mjs | ||
| const fs = require('fs'); | ||
|
|
||
| // Specify the path you want to check (like '/' or 'C:/'). | ||
| fs.statfs('.', (err, stats) => { | ||
| if (err) { | ||
| console.error('Error reading file system stats:', err); | ||
| return; | ||
| } | ||
|
|
||
| // Calculate available space in bytes | ||
| const availableSpace = stats.bavail * stats.bsize; | ||
|
|
||
| console.log(`Available space for unprivileged users: ${availableSpace} bytes`); | ||
| }); | ||
| ``` |
There was a problem hiding this comment.
IMO for the sake of the example, error handling isn't needed.
Comment on lines
+7543
to
+7559
| Example: | ||
| ```mjs | ||
| const fs = require('fs'); | ||
|
|
||
| // Specify the path of the filesystem to check (e.g., current directory). | ||
| fs.statfs('.', (err, stats) => { | ||
| if (err) { | ||
| console.error('Error reading file system stats:', err); | ||
| return; | ||
| } | ||
|
|
||
| // 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`); | ||
| }); | ||
| ``` |
Comment on lines
+7573
to
+7590
| Example: | ||
| ```mjs | ||
| const fs = require('fs'); | ||
|
|
||
| // Specify the path of the filesystem to check (e.g., current directory). | ||
| fs.statfs('.', (err, stats) => { | ||
| if (err) { | ||
| console.error('Error reading file system stats:', err); | ||
| return; | ||
| } | ||
|
|
||
| // Get the total number of blocks | ||
| const totalBlocks = stats.blocks; | ||
|
|
||
| console.log(`Total number of blocks on the filesystem: ${totalBlocks}`); | ||
| }); | ||
| ``` | ||
Comment on lines
+7627
to
+7644
| Example: | ||
| ```mjs | ||
| const fs = require('fs'); | ||
|
|
||
| // Specify the path of the filesystem to check (e.g., current directory). | ||
| fs.statfs('.', (err, stats) => { | ||
| if (err) { | ||
| console.error('Error reading file system stats:', err); | ||
| return; | ||
| } | ||
|
|
||
| // 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`); | ||
| }); | ||
| ``` | ||
Comment on lines
+7656
to
+7658
| This value is the decimal representation of the magic number* of the filesystem. Converting this number|bigint to hexadecimal will return the magic number. | ||
| *magic number- refers to the hexadecimal numeric coding mapped to each filesystem. |
| @@ -7544,7 +7598,7 @@ added: | |||
| * {number|bigint} | |||
| Optimal transfer block size. | |||
| Optimal transfer block size(this value is in bytes for POSIX-compliant or UNIX-like Operating Systems including but not limited to Windows, Linux, MacOS, FreeBSD, OpenBSD, NetBSD, Solaris/Illumos etc). | |||
There was a problem hiding this comment.
Suggested change
| Optimal transfer block size(this value is in bytes for POSIX-compliant or UNIX-like Operating Systems including but not limited to Windows, Linux, MacOS, FreeBSD, OpenBSD, NetBSD, Solaris/Illumos etc). | |
| Optimal transfer block size (measured in bytes) |
Why is all this extra info here?
Comment on lines
7655
to
+7658
| Type of file system. | ||
| This value is the decimal representation of the magic number* of the filesystem. Converting this number|bigint to hexadecimal will return the magic number. | ||
| *magic number- refers to the hexadecimal numeric coding mapped to each filesystem. |
There was a problem hiding this comment.
Suggested change
| Type of file system. | |
| This value is the decimal representation of the magic number* of the filesystem. Converting this number|bigint to hexadecimal will return the magic number. | |
| *magic number- refers to the hexadecimal numeric coding mapped to each filesystem. | |
| Type of file system, represented by the decimal form of the file's magic number. |
Comment on lines
+7660
to
+7748
| 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> | ||
There was a problem hiding this comment.
Instead of a table, is there a wikipage or something that users can be referred to?
|
Can you fix your commit message? Something like:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Defined the return type for statfs.bsize. Added examples for statfs.bavail, statfs.bfree, statfs.blocks and statfs.files for clarity. Explained why statfs.type returns a int|bigint value and added a table with most commonly used magic numbers and their filesystems.
Fixes: #50749