nodejs/node

Missing documentation in `fs.StatFs`

クローズ

#50,749 opened on 2023/11/15

GitHub で見るコントリビューターガイド
 (9 件のコメント) (5 件のリアクション) (0 人の担当者)JavaScript (35,535 件のフォーク)batch import
docfsgood first issue

Repository metrics

Stars
 (117,218 個のスター)
PR merge metrics
 (平均マージ 18d 17h) (30d で 219 merged PRs)

説明

Affected URL(s)

https://nodejs.org/api/fs.html#class-fsstatfs

Description of the problem

  • statfs.bsize fails to mention if the size is reported in bits or bytes
  • While statfs.bavail and statfs.bfree can be used to calculate available and free space, it would be appropriate to put an example on how to use them Example: 
    import { statfs } from "fs/promises"
const statsfs = await statfs("/tmp")
const available_bits_or_bytes_not_documented = statsfs.bsize * statsfs.bavail
  • Similarly, statfs.blocks and statfs.files would strongly benefit from an example
  • What's statfs.type and why is it a number?

コントリビューターガイド

調査方針
The issue requests clarifications and examples for properties of the `StatFs` class in the Node.js `fs` documentation, specifically `bsize`, `bavail`, `bfree`, `blocks`, `files`, and `type`. The relevant file is likely `doc/api/fs.md` in the Node.js repository. The maintainer may have already commented on the correct units and usage. To address this, review the existing documentation and any linked references (e.g., POSIX `statvfs`). Then update the description to specify that `bsize` is in bytes, provide a code example showing how to calculate available space, and explain that `type` refers to the filesystem type identifier (e.g., from Linux's `f type` header).
技術スタック
nodejstypescript
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
basic Node.js knowledgefamiliarity with fs module
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80