microsoft / microsoft/TypeScript
Add a `redeclare` keyword to redeclare class attributes, behaving like `override !:` while keeping type modifiers.
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
🔍 Search Terms
redeclare
declare override
Related issues:
- https://github.com/microsoft/typescript/issues/51515
- https://github.com/microsoft/typescript/issues/37771
- https://github.com/microsoft/TypeScript/issues/4062
✅ Viability Checklist
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- 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, new syntax sugar for JS, etc.)
- This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
⭐ Suggestion
A redeclare keyword behaving like override + declare while keeping previous type modifiers (e.g. readonly, protected, public).
type BaseType = {};
type Overriden = {x: number};
class A {
protected readonly foo: BaseType;
constructor(protected readonly faa: BaseType) {}
}
class B extends A {
redeclare foo: Overriden;
// equivalent to "override [protected readonly] foo!: Overriden"
constructor( redeclare faa: Overriden ) { super(faa); }
// idem above. Do not set faa itself.
}
We could use redeclare with modifiers, e.g. public or -readonly to override previous type modifiers:
redeclare public faa: Overriden; // make it public, do not change whether it is readonly or not, etc.
redeclare public faa; // make it public, do not change its type, whether it is readonly or not, etc.
redeclare -readonly faa; // make it read-write, do not change its type or its visibility.
I also suggest the related changes:
- in constructor parameters,
!:would mean "declare but do not set". - using
declareas an alias to!:when used in constructor parameters, or withoverride.
Note: redeclare could also be used in other contexts, e.g. to precise a variable type (cf related issue), but this is not in the scope of this suggestion.
📃 Motivating Example
Currently, if you want to override an attribute, you have to:
type BaseType = {};
type Overriden = {x: number};
class A {
protected readonly foo: BaseType;
}
class B extends A {
override readonly foo!: Overriden;
}
However, if you forget one of the type modifier (here: protected) you would have no warnings as it might be voluntary. A reader do not know if this is a mistake or not.
By using redeclare you would ensure no type modifier is forgotten, while making intents explicit.
Indeed, if the type modifiers are modified in class A, using redeclare ensures that all subclasses has the correct type modifiers (except if explicitly stated otherwise).
Also, redeclare would enable to redeclare a type from the constructor, instead of having to provide the type twice.
type BaseType = {};
type Overriden = {x: number};
class A {
protected readonly foo: BaseType;
}
class B extends A {
constructor( redeclare foo: Overriden ) { ... }
}
💻 Use Cases
- What do you want to use this for?
Safely re-declaring classes attributes.
- What shortcomings exist with current approaches?
- We have to rewrite all type modifiers.
- In constructors parameters, we would have useless (or even unwanted) attribute assignations.
- Without constructors parameters, requires to provide the type twice.
- With a generic base class, this is quite brittle : the base class and each of its subclasses needs to know which of the attribute might be redeclared. This could lead too an excessive amount of generic types if too much attributes.
- What workarounds are you using in the meantime?
I use constructors parameters with the useless assignations.
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 reading related issues #51515, #37771, and #4062 alongside the redeclare examples and viability checklist. Clarify the proposed behavior for class attributes and constructor parameters, including inherited modifiers and explicit overrides; done would require an agreed language design, which this issue does not yet provide.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100