microsoft / microsoft/TypeScript

JSDoc @this does not propagate to the actual type of a function

Abierto
#44,461 2 comentarios 1 reacción 1 asignado Ver en GitHub

@sandersn ya está trabajando en esto.

Desde el 10/6/2021.

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

Descripción

Bug Report

When using @this to annotate a function, the underlying type of that function does not reflect the TypeScript equivalent properly when used as a type elsewhere.

🔎 Search Terms

function this jsdoc

🕗 Version & Regression Information
  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about JSDoc
⏯ Playground Link

Playground link with relevant code

💻 Code

You should test this out in VSCode, as the Play link appears to handle a few things incorrectly.

// Note: hovering over `someCallback` shows in annotation that
// the type of `this` is *, which is weird
// Also note a secondary bug that `someCallback` is assumed to be
// a constructor, even though it isn't, and there is no way
// to override it.
/**
 * @this {HTMLElement}
 * @param {MouseEvent} e
 */
function someCallback(e)
{
    this.textContent = 'hello';
}

// Note: this does not seem to work in Play, but VSCode
// seems to handle @type properly here. The only issue is
// that someCallback does not seem to have a proper `this` type.
/** @type {typeof someCallback} */
function equivalentType(e)
{
    // `this` is "any". In VSCode, `e` has the correct type,
    // but `this` is untyped.
    someCallback.call(this, e);
}

// This should be equivalent to the function above & to someCallback, but is not.
// This is the correct type for `typeof someCallback`, however.
/** @type {(this: HTMLElement, e: MouseEvent) => void} */
function actualEquivalentType(e)
{
    // "this" is typed properly
    someCallback.call(this, e);
}
🙁 Actual behavior

typeof someCallback does not include the this JSDoc component, and is typed as (e: MouseEvent) => void

🙂 Expected behavior

typeof someCallback should be (this: HTMLElement, e: MouseEvent) => void

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.

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.