microsoft / microsoft/TypeScript
Incorrect static method overload inheritance between TypeScript and JavaScript with JSDoc
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.4k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔎 Search Terms
Static method overload, inheritance, JSDoc, static method TypeScript, class inheritance, overload error, static side incompatible.
🕗 Version & Regression Information
TypeScript Version: 5.6.3
Problem
When using JSDoc in JavaScript as a substitute for TypeScript, the behavior of static method overloads in derived classes should match TypeScript.
⏯ Playground Link
💻 Code
The following TypeScript code works as expected:
class Vector1 {
static ["+"](vector: Readonly<Vector1>, scalar: number): Vector1;
static ["+"](first: Readonly<Vector1>, second: Readonly<Vector1>): Vector1;
static ["+"](arg1: Readonly<Vector1>, arg2: Readonly<Vector1> | number): Vector1 {
// Implementation
return new Vector1();
}
x: number;
}
class Vector2 extends Vector1 {
static ["+"](vector: Readonly<Vector2>, scalar: number): Vector2;
static ["+"](first: Readonly<Vector2>, second: Readonly<Vector1>): Vector2;
static ["+"](first: Readonly<Vector2>, second: Readonly<Vector2>): Vector2;
static ["+"](arg1: Readonly<Vector2>, arg2: Readonly<Vector2> | Readonly<Vector1> | number): Vector2 {
// Implementation
return new Vector2();
}
y: number;
}
However, translating this to JavaScript using JSDoc gives an error:
class Vector1 {
/**
* @overload
* @param {Readonly<Vector1>} vector
* @param {number} scalar
* @returns {Vector1}
*/
/**
* @overload
* @param {Readonly<Vector1>} first
* @param {Readonly<Vector1>} second
* @returns {Vector1}
*/
/**
* @param {Readonly<Vector1>} arg1
* @param {Readonly<Vector1> | number} arg2
* @returns {Vector1}
*/
static ["+"](arg1, arg2) {
// Implementation
return new Vector1();
}
/** @type {number} */
x;
}
class Vector2 extends Vector1 {
/**
* @overload
* @param {Readonly<Vector2>} vector
* @param {number} scalar
* @returns {Vector2}
*/
/**
* @overload
* @param {Readonly<Vector2>} first
* @param {Readonly<Vector1>} second
* @returns {Vector2}
*/
/**
* @overload
* @param {Readonly<Vector2>} first
* @param {Readonly<Vector2>} second
* @returns {Vector2}
*/
/**
* @override
* @param {Readonly<Vector2>} arg1
* @param {Readonly<Vector2> | Readonly<Vector1> | number} arg2
* @returns {Vector2}
*/
static ["+"](arg1, arg2) {
// Implementation
return new Vector2();
}
/** @type {number} */
y;
}
🙁 Actual behavior
The code errors out:
Class static side 'typeof Vector2' incorrectly extends base class static side 'typeof Vector1'.
Types of property '["+"]' are incompatible.
Type '{ (vector: Readonly, scalar: number): Vector2; (first: Readonly, second: Readonly): Vector2; (first: Readonly<...>, second: Readonly<...>): Vector2; }' is not assignable to type '{ (vector: Readonly, scalar: number): Vector1; (first: Readonly, second: Readonly): Vector1; }'.
Types of parameters 'vector' and 'vector' are incompatible.
Property 'y' is missing in type 'Readonly' but required in type 'Readonly'.ts(2417)
🙂 Expected behavior
The code should pass the type check.
Additional information about the issue
This issue occurs when the strictFunctionTypes compiler option is enabled (set to true). Disabling this option makes the error disappear, but this shouldn't be required for static method overload inheritance to work correctly.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the static overload inheritance case in the linked TypeScript Playground with strictFunctionTypes enabled, then trace the compiler's static-side compatibility checking for the Vector1 and Vector2 classes. Done means the JSDoc JavaScript version type-checks consistently with the equivalent TypeScript version without disabling strictFunctionTypes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100