nodejs/node

Missing documentation in `fs.StatFs`

Fechada

#50.749 aberto em 15 de nov. de 2023

Ver no GitHubGuia do colaborador
 (9 comentários) (5 reações) (0 responsável)JavaScript (35.535 forks)batch import
docfsgood first issue

Métricas do repositório

Stars
 (117.218 estrelas)
Métricas de merge de PR
 (Mesclagem média 18d 17h) (219 fundiu PRs em 30d)

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?

Guia do colaborador

Direção de pesquisa
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).
Pilha de tecnologia
nodejstypescript
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
basic Node.js knowledgefamiliarity with fs module
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80