microsoft / microsoft/TypeScript

jsdoc @type is not working properly for some class method variant

Aperta
#39,667 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Awaiting More Feedback Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

TypeScript Version: 4.0.0-beta and 3.9.2

Search Terms: jsdoc, type, typedef, class method, typechecking

Code

// @strict: false

/**
 * @typedef {(newNumber: number) => void} SetNumberFunc
 */

class A {
    /**
     * @type {number}
     */
    a = 0;

    constructor() {
        this.a = 0;
    }

    /**
     * @type {SetNumberFunc}
     */
    setAVariant1(newNumber) {
        this.a = newNumber;
    }
}

Expected behavior: The newNumber param should have a number type when hovering on the setAVariant1 method.

Actual behavior: The newNumber param have any type when hovering on the setAVariant1 method.

Playground Link: Playground Link

Related Issues: -

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 dalla riproduzione collegata di TypeScript Playground e analizza come viene gestita l'annotazione JSDoc @type per il metodo della classe setAVariant1. Confronta il tipo mostrato al passaggio del mouse su newNumber con il tipo number previsto e verifica che, quando la correzione è completa, la riproduzione riporti number invece di any.

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

Valutazione

Stack tecnologico
javascript, typescript
Ambito
compilers
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.