Microsoft/TypeScript

JSDoc comments for async_hooks are confusing/misleading

Open

#62.967 aperta il 9 gen 2026

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)TypeScript (6726 fork)batch import
Experience EnhancementHelp WantedSuggestion

Metriche repository

Star
 (48.455 star)
Metriche merge PR
 (Merge medio 3g 5h) (8 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina i commenti JSDoc in async hooks.d.ts e assicurati che l'avviso di deprecazione non appaia su AsyncLocalStorage. Considera di separare la documentazione per diverse esportazioni o aggiornare il commento per chiarire che l'avviso si applica solo all'API core di async hooks, non ad AsyncLocalStorage.
Tech stack
typescript
Dominio
documentationdeveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90