Skip to content

doc: update documentation in fs.StatsFs - #54309

Closed
Codder-lab wants to merge 3 commits into
nodejs:mainfrom
Codder-lab:suyashpotdar/update-statsfs-docs
Closed

doc: update documentation in fs.StatsFs#54309
Codder-lab wants to merge 3 commits into
nodejs:mainfrom
Codder-lab:suyashpotdar/update-statsfs-docs

Conversation

@Codder-lab

Copy link
Copy Markdown

No description provided.

@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 Aug 10, 2024
@avivkeller

Copy link
Copy Markdown
Member

Thanks for the PR! In order for this to land, the commit message must start with the subsystem (fs), following by an active verb.

For example, a valid commit for this PR would start with fs: add ...

@avivkeller

Copy link
Copy Markdown
Member

Thanks for updating the commit message, but you need to rebase to overwrite the original message.

@Codder-labCodder-lab changed the title #50749 Issue: Update documentation in fs.StatsFs#50749 fs: update documentation in fs.StatsFsAug 10, 2024
@Codder-labCodder-lab changed the title #50749 fs: update documentation in fs.StatsFs#50749 Issue: Update documentation in fs.StatsFsAug 10, 2024
@Codder-lab
Codder-labforce-pushed the suyashpotdar/update-statsfs-docs branch 3 times, most recently from 81179aa to e2651f7CompareAugust 10, 2024 20:10
@Codder-lab

Copy link
Copy Markdown
Author

Thanks for updating the commit message, but you need to rebase to overwrite the original message.

Look at #54309

@Codder-lab
Codder-labforce-pushed the suyashpotdar/update-statsfs-docs branch from aaccc27 to aa3c459CompareAugust 11, 2024 11:56
@marco-ippolito

Copy link
Copy Markdown
Member

actually being a doc only it should be doc:

@Codder-lab
Codder-labforce-pushed the suyashpotdar/update-statsfs-docs branch from aa3c459 to 3bd562cCompareAugust 11, 2024 13:13
@Codder-lab

Codder-lab commented Aug 11, 2024

Copy link
Copy Markdown
Author

actually being a doc only it should be doc:

#54309 "Could you please verify if it is correct now?"

@marco-ippolitomarco-ippolito changed the title #50749 Issue: Update documentation in fs.StatsFsdoc: update documentation in fs.StatsFsAug 11, 2024
Comment threaddoc/api/fs.md Outdated
Free blocks available to unprivileged users.

**Example:**
```javascript

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.

Suggested change
```javascript
```mjs

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.

Could you please verify all the changes?

Comment threaddoc/api/fs.md Outdated
Free blocks in file system.

**Example:**
```javascript

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.

Suggested change
```javascript
```mjs

Comment threaddoc/api/fs.md Outdated
Total data blocks in file system.

**Example:**
```javascript

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.

Suggested change
```javascript
```mjs

Comment threaddoc/api/fs.md Outdated

Total file nodes in file system.

```javascript

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.

Suggested change
```javascript
```mjs

Comment threaddoc/api/fs.md Outdated

Free blocks available to unprivileged users.

**Example:**

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.

Suggested change
**Example:**

Comment threaddoc/api/fs.md Outdated

Free blocks in file system.

**Example:**

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.

Suggested change
**Example:**

Comment threaddoc/api/fs.md Outdated

Total data blocks in file system.

**Example:**

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.

Suggested change
**Example:**

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.

Can you please verify the changes?

Comment threaddoc/api/fs.md
```mjs
import { statfs } from "fs/promises";

async function getAvailableSpace(path) {

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.

For the sake of simplicity, isn't it better to use top level await instead of an async function?

@aduh95

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

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@Codder-lab@avivkeller@marco-ippolito@aduh95@jasnell@lpinca@nodejs-github-bot