microsoft / microsoft/TypeScript

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

Offen
#44,461 2 Kommentare 1 Reaktion 1 zugewiesene Person Auf GitHub ansehen

@sandersn arbeitet bereits daran.

Seit 10.6.2021.

Needs Investigation
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.