docs: suggest adding performance comparison table for fs.promises vs callback API
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 122k
- Forks
- 37.3k
- Avg merge
- 4d 2h
- Merged PRs (30d)
- 283
Description
建议
在 fs 模块文档中添加一个性能对比说明，解释 fs.promises API 与传统 callback API 在性能上的差异和适用场景。
背景
很多开发者在选择文件系统 API 时不清楚 promises 和 callback 版本的性能差异。添加以下内容会很有帮助：
- 高并发场景下的性能表现差异
- 内存使用对比
- 何时应该使用 callback 版本以获得最佳性能
这对于构建高吞吐量的 Node.js 应用很有参考价值。
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100