docs: suggest adding performance comparison table for fs.promises vs callback API

Open
#65,930 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
node.js
Domain
documentation

Research direction

Start with the fs module documentation and its existing descriptions of the promises and callback APIs. Research or verify the requested high-concurrency performance, memory-use, and callback-selection guidance before adding the comparison. Done means the documentation clearly covers all three points without overstating unsupported differences.

Written by the indexing model from the issue text.

Description

建议

在 fs 模块文档中添加一个性能对比说明，解释 fs.promises API 与传统 callback API 在性能上的差异和适用场景。

背景

很多开发者在选择文件系统 API 时不清楚 promises 和 callback 版本的性能差异。添加以下内容会很有帮助：

  1. 高并发场景下的性能表现差异
  2. 内存使用对比
  3. 何时应该使用 callback 版本以获得最佳性能

这对于构建高吞吐量的 Node.js 应用很有参考价值。

Dominant language
JavaScript
Stars
122k
Forks
37.4k
Avg merge
4d 3h
Merged PRs (30d)
273

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nodejs/node

All issues in nodejs/node

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.