Microsoft/TypeScript

JSDoc comments for async_hooks are confusing/misleading

Open

#62,967 建立於 2026年1月9日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)TypeScript (48,455 star) (6,726 fork)batch import
Experience EnhancementHelp WantedSuggestion

描述

Acknowledgement

  • I acknowledge that issues using this template may be closed without further explanation at the maintainer's discretion.

Comment

The JSDoc comments from the async_hooks module state not to use the module, and then go on to immediately suggest an "alternative" that is in the module itself.

We strongly discourage the use of the async_hooks API

  • AsyncLocalStorage

If you look at the node.js docs, it makes sense because these two things are on separate pages, but in TS, this warning is shown on import { AsyncLocalStorage } from 'node:async_hooks';

This might be a larger codegen/docs issue as well for other modules that have multiple doc pages.

貢獻者指南

技術棧
typescriptnodejs
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
TypeScript basicsNode.js async hooks knowledge
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
Start by examining the type definitions for async hooks in the TypeScript repository (likely in lib/node/async hooks.d.ts). Compare the JSDoc comments with the official Node.js documentation to identify the misleading parts. Check if there are any existing discussions or PRs related to this issue. Consider whether the fix should be applied to the type definitions or if the issue originates from the code generation process.