microsoft / microsoft/TypeScript
should error on assignment that shadows a prototype method
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
🔎 Search Terms
own property, shadow, prototype, method, field, inheritance
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed
⏯ Playground Link
💻 Code
class Foo {
constructor() {
this.prototypeMethod = () => {
console.log('shadows prototype method');
}
}
prototypeMethod() {
console.log('method on prototype');
}
}
🙁 Actual behavior
no error
🙂 Expected behavior
error - something like "Type 'Foo' has no instance property named 'prototypeMethod'. If you meant to reassign the method 'prototypeMethod', it must be a function-valued instance property instead of a prototype method.".
I expect an error here because the code is effectively equivalent to
class Foo {
prototypeMethod = () => {
console.log('shadows prototype method');
};
prototypeMethod() {
console.log('method on prototype');
}
}
which is a TS error (see https://github.com/microsoft/TypeScript/issues/13141).
Furthermore, it breaks error reporting in subclasses. The following code correctly reports a TS error due to the extended class not being able to override an instance property with a method:
(playground)
class Foo {
instanceProperty = () => {
console.log('function-valued instance property');
}
}
class Bar extends Foo {
// TS ERROR: Class 'Foo' defines instance member property 'instanceProperty', but extended class 'Bar' defines it as instance member function.(2425)
instanceProperty() {
console.log('overridden with method')
}
}
const b = new Bar();
b.instanceProperty(); // prints 'function-valued instance property'
However, this does not (playground)
class Foo {
constructor() {
this.method = () => {
console.log('function-valued instance property')
}
}
method() {
console.log('method');
}
}
class Bar extends Foo {
// no error here :(
method() {
console.log('overridden with method')
}
}
const b = new Bar();
b.method(); // prints 'function-valued instance property'
Additional information about the issue
inspired by https://github.com/typescript-eslint/typescript-eslint/issues/10427
cc @miguel-leon
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
Reproduce the constructor-assignment and subclass examples in the linked TypeScript Playground, then compare them with the equivalent function-valued instance-property case. Trace the compiler's class member and inheritance checks; done means assignments that shadow prototype methods produce the expected diagnostic and subclass overrides are checked consistently.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100