microsoft / microsoft/TypeScript

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

Ouverte
#39,667 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Awaiting More Feedback Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

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: -

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la reproduction TypeScript Playground associée et examinez la manière dont l’annotation JSDoc @type est traitée pour la méthode de classe setAVariant1. Comparez le type affiché au survol de newNumber avec le type number attendu, et vérifiez que la reproduction signale number plutôt que any une fois la correction terminée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, typescript
Domaine
compilers
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.