microsoft / microsoft/TypeScript

JSDoc: Typescript is interpreting varargs in function signature as required argument if jsdoc function notation is used in typedef.

Ouverte
#30,274 0 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.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

TypeScript Version: typescript@3.4.0-dev.20190308

Search Terms: jsdoc, varargs, typedef,

Code

// if I want to use typescript format
// this format is not supported by WebStorm
/** @typedef {(...a2:Array<string>) => void} A */
/** @type {A} */
let a;
a(); // but this works fine with typescript

// if I want to use JSDoc format
// this format is supported by WebStorm
/** @typedef {function(...string):void} B */
/** @type {B} */
let b;
b(); // but this not work, TS2555: Expected at least 1 arguments, but got 0

Expected behavior:
Both formats should be interpreted in same way.

Actual behavior:

test.js:13:1 - error TS2555: Expected at least 1 arguments, but got 0.
13 b(); // but this not work, TS2555: Expected at least 1 arguments, but got 0
   ~~~
  test.js:10:24
    10 /** @typedef {function(...string):void} B */
                              ~~~~~~~~~
    An argument for '0' was not provided.

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 JavaScript minimale dans l'issue et comparez la manière dont TypeScript gère les deux formes de typedef JSDoc, en vous concentrant sur le paramètre varargs et le diagnostic TS2555. Le travail est terminé lorsque les deux formes permettent d'appeler la fonction résultante sans argument, avec des tests couvrant le comportement équivalent.

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é
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

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