Allow accessors in ambient class declarations by rbuckton · Pull Request #32787 · microsoft/TypeScript (original) (raw)
As part of the effort to support ECMAScript class fields, we will need to roll out features to the TypeScript compiler in phases. One of the key areas we need to address is the ability to properly distinguish between a "field" (a.k.a. a "Property Declaration" in TypeScript parlance), and an "accessor" (a getter or setter declaration). The reason we need to have these definitions cleanly separated is so that we can eventually issue error messages when you define a field on a superclass and an accessor on a subclass with the same name (or vice versa).
However, this is problematic today for several reasons:
- Subclasses currently can override a property declaration from a superclass with an accessor on a subclass:
var Map: MapConstructor;
interface Map<K, V> {
readonly size: number;
...
}
class MyMap extends Map {
get size() {
return super.size + 1;
}
…
} - Declaration emit for class declarations converts get/set accessor pairs into property declarations and get-only accessors into
readonlyproperty declarations:
// input: main.ts
class MyClass {
get x(): number { return 1; }
set x(value: number) { … }
}
// output: main.d.ts
declare class MyClass {
x: number;
} - Interfaces can specify property declarations, but can't specify accessors.
This PR seeks to address some of these issues:
- Ambient Class declarations may now specify getters/setters.
- Code fixes for implementing a Class as if it were an interface, or extending an abstract class will now add implementations for getters/setters instead of fields when the implemented member is a getter or setter.
- Getters and Setters defined on an ambient class are preserved when emitting an output declaration file.
This PR does not change the following behavior:
- Getters and Setters are still not permitted on interfaces.
- Getters and Setters on a non-ambient class declaration will continue to be emitted as a property declaration.
- It is still not an error to have a subclass and superclass have a mismatch in a definition of a property that is either an accessor or a property declaration.
We are not changing the declaration emit for getters/setters immediately so that declaration files built against existing TypeScript code prior to this feature can still be used with earlier versions of the TypeScript compiler. We do plan to change the declaration emit in a future release, which will give users a transitional period where they can become accustomed to the new syntax.
Examples:
declare class C { get x(): number; }