nodejs/node

Missing documentation in `fs.StatFs`

Fermée

#50 749 ouverte le 15 nov. 2023

Voir sur GitHubGuide contributeur
 (9 commentaires) (5 réactions) (0 personne assignée)JavaScript (35 535 forks)batch import
docfsgood first issue

Métriques du dépôt

Stars
 (117 218 étoiles)
Métriques de merge PR
 (Merge moyen 18j 17h) (219 PRs mergées en 30 j)

Description

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?

Guide contributeur

Direction de recherche
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).
Stack technique
nodejstypescript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
basic Node.js knowledgefamiliarity with fs module
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80