microsoft / microsoft/TypeScript
maintain certain class property characteristics in mapped types, like protected/private visibility, and instance property vs instance function
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
mapped types with protected private members
Suggestion
Feature request:
Allow types/interfaces to contain member visibility as well as property type ("instance member function" vs "instance member property") and perhaps other intrinsics.
Or at least keep these characteristics intact in mapped types where the mapped type is generated from class types.
Use Cases
I've made a function called multiple that allows me to do multiple inheritance. In plain JavaScript, it works fine, like this:
class One {one() {}}
class Two {two() {}}
class Three {three() {}}
class Four extends multiple(One, Two, Three) {
test() {
this.one() // OK
this.two() // OK
this.three() // OK
}
}
So far, after making type definitions for multiple(), the above works fine in TypeScript. playground example.
However when making properties protected or private, those properties are lost from the mapped type returned from multiple(), and therefore inheritance of protected (or denial of accessing private) members doesn't work:
class One {protected one() {}}
class Two {protected two() {}}
class Three {private three() {}}
class Four extends multiple(One, Two, Three) {
test() {
this.one() // ERROR, Property 'one' does not exist on type 'Four'. Expected no error.
this.two() // ERROR, Property 'two' does not exist on type 'Four'. Expected no error.
this.three() // ERROR, Property 'three' does not exist on type 'Four'. Expected an error relating to private access.
}
}
Here's the playground example.
Because the private properties are deleted from the mapped type (just like the protected ones are), it becomes possible to inadvertently use private properties because the type system says they don't exist:
class One { private foo = 1 }
class Two { }
class Three extends multiple(One, Two) {
foo = false
test() {
this.foo = true // Uh oh! There's no error using the private property!
}
}
Here's the playground example.
Another problem is methods of the classes passed into multiple() are converted from instance member function to instance member property, and this happens:
class One {one() {}}
class Two {two() {}}
class Three {three() {}}
class Four extends multiple(One, Two, Three) {
one() {} // ERROR, Class '{ three: () => void; two: () => void; one: () => void; }' defines instance member property 'one', but extended class 'Four' defines it as instance member function.(2425)
}
Here's the playground example.
Related
- https://github.com/microsoft/TypeScript/issues/26760
- https://github.com/microsoft/TypeScript/issues/7124
- https://github.com/microsoft/TypeScript/issues/3854
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code I'm not sure
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
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
The issue names no repository files or tests; start by reproducing the linked playground examples around mapped types, multiple(), and class member compatibility. Done would require a decided design that preserves protected/private visibility and distinguishes instance member functions from properties, with appropriate diagnostics for private access and overrides.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100