microsoft / microsoft/TypeScript

Named function arguments not supported in JSDOC

Aperta
#56,574 7 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

In Discussion Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.4k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

Does this issue occur when all extensions are disabled?: Yes

Version: 1.84.2 (user setup)
Commit: 1a5daa3a0231a0fbba4f14db7ec463cf99d7768e
Date: 2023-11-09T10:51:52.184Z
Electron: 25.9.2
ElectronBuildId: 24603566
Chromium: 114.0.5735.289
Node.js: 18.15.0
V8: 11.4.183.29-electron.0
OS: Windows_NT x64 10.0.22621

While defining a function type in JSDOC, if a name if provided for the argument, TypeScript fails to recognize it.

Steps to Reproduce:

This is a snippet of sample code that works and does not work.

The first typedef does not include an argument name, IntelliSense refers to the argument as arg0.

The second typedef does include an argument name, and TypeScript flags it as an error.

/**
* @typedef {function(string ): Promise<string>} IdoRequestFunction
*/

/** @type IdoRequestFunction */

export default async function request(idoRequest) {

    return idoRequest;

}

/**
* @typedef {function(idoRequest:string ): Promise<string>} IdoRequestFunctionX
*/

/** @type IdoRequestFunction */

export async function requestX(idoRequest) {

    return idoRequest;

}

image

Thank you for your assistance.

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 con la riproduzione JavaScript/JSDoc fornita e segui come TypeScript analizza e verifica i tipi di funzione con parametri denominati. Il lavoro è completato quando l'argomento denominato viene accettato senza errori e IntelliSense usa quel nome invece di arg0.

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

Valutazione

Stack tecnologico
javascript, 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
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.