Skip to content

doc: add missing examples and information to fs - #55298

Closed
shrenisc wants to merge 8 commits into
nodejs:mainfrom
shrenisc:statfs_docs_update
Closed

doc: add missing examples and information to fs#55298
shrenisc wants to merge 8 commits into
nodejs:mainfrom
shrenisc:statfs_docs_update

Conversation

@shrenisc

@shreniscshrenisc commented Oct 6, 2024•
edited
Loading

Copy link
Copy Markdown

Added examples and provided return type definitions

Fixes: #50749

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Oct 6, 2024
avivkeller
avivkeller reviewed Oct 7, 2024
View reviewed changes
Comment threaddoc/api/fs.md Outdated
Comment threaddoc/api/fs.md Outdated
@shrenisc

shrenisc commented Oct 8, 2024

Copy link
Copy Markdown
Author

after research, i confirmed that the js code that I have written follows the cjs format. Could you tell me if there is something else you wanted to be done?

avivkeller
avivkeller reviewed Oct 8, 2024
View reviewed changes
Comment threaddoc/api/fs.md Outdated
Comment threaddoc/api/fs.md Outdated
@shrenisc

shrenisc commented Oct 10, 2024

Copy link
Copy Markdown
Author

Hi, are there any more changes needed to be done?

@avivkeller

avivkeller commented Oct 10, 2024

Copy link
Copy Markdown
Member

@nodejs/fs PTAL

@aduh95

aduh95 commented Oct 11, 2024

Copy link
Copy Markdown
Contributor

Can you fix the linter issues please? Let me know if you need help

@shrenisc

shrenisc commented Oct 11, 2024

Copy link
Copy Markdown
Author

Can you fix the linter issues please? Let me know if you need help

I have resolved them now. Thank you

avivkeller
avivkeller reviewed Oct 11, 2024
View reviewed changes
Comment threaddoc/api/fs.md Outdated
Comment on lines +7514 to +7516
const fs = require('node:fs');
// Calculate available space in bytes
fs.statfs('.', (err, stats) => {

@avivkelleravivkellerOct 11, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This isn't the same as the other example:

Suggested change
const fs = require('node:fs');
// Calculate available space in bytes
fs.statfs('.', (err, stats) => {
const { statfs } = require('node:fs');
// Calculate available space in bytes
statfs('.', (err, stats) => {

@shreniscshreniscOct 11, 2024

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

This isn't the same as the other example:

i have corected it now

@shrenisc

shrenisc commented Oct 12, 2024

Copy link
Copy Markdown
Author

can i get some help on this error:
make: *** [Makefile:1398: lint-js] Error 1
Error: Process completed with exit code 2.

@aduh95

aduh95 commented Oct 12, 2024

Copy link
Copy Markdown
Contributor

can i get some help on this error: make: *** [Makefile:1398: lint-js] Error 1 Error: Process completed with exit code 2.

Is this an error you see locally? The output from the CI might be clearer to work with

@shrenisc

shrenisc commented Oct 12, 2024

Copy link
Copy Markdown
Author

can i get some help on this error: make: *** [Makefile:1398: lint-js] Error 1 Error: Process completed with exit code 2.

Is this an error you see locally? The output from the CI might be clearer to work with

no this is a CI error that i see on the checks.

@shrenisc

shrenisc commented Oct 12, 2024

Copy link
Copy Markdown
Author

I am still getting the same error when the PR is checked.

@shrenisc
doc: add missing examples and information to fs
eb3a051
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: nodejs#50749
@shrenisc
doc: add missing examples and information to fs
d1f790b
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: nodejs#50749
@shrenisc
doc: add missing examples and information to fs
e6c0b87
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: nodejs#50749
@shrenisc
doc: add missing examples and information to fs
61ac52d
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: nodejs#50749
@shrenisc
doc: add missing examples and information to fs
0ff4c70
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: nodejs#50749
@shrenisc
doc: add missing examples and information to fs
b07a319
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: nodejs#50749
@shrenisc
doc: add missing examples and information to fs
7feeb24
added examples and type definitions
Fixes:nodejs#50749
@shrenisc
doc: add missing examples and information to fs
382edc1
added examples and type definitions
Fixes:nodejs#50749
@shrenisc

shrenisc commented Oct 14, 2024

Copy link
Copy Markdown
Author

I am still getting the same error when the PR is checked.

Hi, can you check now? All checks should pass now.

@aduh95

aduh95 commented May 27, 2026

Copy link
Copy Markdown
Contributor

Superseded by #62578

@aduh95aduh95 closed this May 27, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@avivkelleravivkelleravivkeller left review comments

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Missing documentation in fs.StatFs

4 participants

@shrenisc@avivkeller@aduh95@nodejs-github-bot