microsoft / microsoft/TypeScript

Named function arguments not supported in JSDOC

Abierto
#56,574 7 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

In Discussion Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con la reproducción proporcionada en JavaScript/JSDoc y sigue cómo TypeScript analiza y comprueba los tipos de función con parámetros con nombre. Se considera terminado cuando el argumento con nombre se acepta sin errores y IntelliSense usa ese nombre en lugar de arg0.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, typescript
Área
compilers
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.