microsoft / microsoft/TypeScript

jsdoc @type is not working properly for some class method variant

Open
#39,667 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

TypeScript Version: 4.0.0-beta and 3.9.2

Search Terms: jsdoc, type, typedef, class method, typechecking

Code

// @strict: false

/**
 * @typedef {(newNumber: number) => void} SetNumberFunc
 */

class A {
    /**
     * @type {number}
     */
    a = 0;

    constructor() {
        this.a = 0;
    }

    /**
     * @type {SetNumberFunc}
     */
    setAVariant1(newNumber) {
        this.a = newNumber;
    }
}

Expected behavior: The newNumber param should have a number type when hovering on the setAVariant1 method.

Actual behavior: The newNumber param have any type when hovering on the setAVariant1 method.

Playground Link: Playground Link

Related Issues: -

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked TypeScript Playground reproduction and inspect how the JSDoc @type annotation is handled for the class method setAVariant1. Compare the hover type of newNumber with the expected number type, and verify that the reproduction reports number rather than any when the fix is complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
compilers
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.