Repository navigation
JSDoc comments for async_hooks are confusing/misleading #62967
Description
Activity
Hi a-non-a-mouse I’ve opened a PR in DefinitelyTyped to clarify the async_hooks JSDoc warning so it doesn’t read as discouraging the module while recommending AsyncLocalStorage from the same import.
Hi a-non-a-mouse, thanks for pointing this out the current JSDoc is indeed confusing from a TypeScript consumer perspective.
I’d be happy to help address this by clarifying the JSDoc so the guidance around async_hooks and AsyncLocalStorage is accurate and non-misleading. If this issue is still open for contributions, I can work on a fix or follow up on the existing approach.
Thanks.
Acknowledgement
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.
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.