microsoft / microsoft/TypeScript

JSDoc disappeared in overloading with mapped type

Aperta
#42,549 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Bug Domain: JSDoc
Lingua principale
Go
Stelle
111k
Fork
14.4k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

Bug Report

🔎 Search Terms

vscode, jsdoc

🕗 Version & Regression Information

4.1.3

⏯ Playground Link

example 1, bug, no jsdoc:
No JSDoc if overloading in mapped type
image

example 2, works well:
Has JSDoc if no overloading in mapped type
image

example 3, bug, no jsdoc:
JSDoc disappeared without overloading

JSDoc disappeared without overloading

💻 Code
type ApiDict = {
  /**
   * jsdoc for getString
   */
  getString: string;
  /**
   * jsdoc for getBoolean
   */
  getBoolean: boolean;
};

type Api = {
  [key in keyof ApiDict]: {
    (url: string): ApiDict[key];
    (url: string, config: {}): { data: ApiDict[key]; extra: any };
  };
};

declare const api: Api;

api.getBoolean('', {});
type ApiDict = {
  /**
   * jsdoc for getString
   */
  getString: string;
  /**
   * jsdoc for getBoolean
   */
  getBoolean: boolean;
};

type Api = {
  [key in keyof ApiDict]: {
    (url: string, config: {}): { data: ApiDict[key]; extra: any };
  };
};

declare const api: Api;

api.getBoolean('', {});
/**
 * jsdoc for JsdocDisappearedWithoutOverloading
 */
interface JsdocDisappearedWithoutOverloading {
  (url: string): any;
}

declare const jsdocDisappearedWithoutOverloading: JsdocDisappearedWithoutOverloading;

jsdocDisappearedWithoutOverloading('');
🙂 Expected behavior

All of examples has jsdoc

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia eseguendo i tre esempi collegati di TypeScript Playground, confrontando i casi di overload nei mapped types con il caso funzionante e con la callable interface autonoma. Usa gli snippet TypeScript forniti per riprodurre il JSDoc mancante. Il lavoro è completato quando tutti gli esempi mantengono il JSDoc dichiarato, inclusi i mapped types con firme di chiamata overloadate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
compilers
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.