microsoft / microsoft/TypeScript
Allow decorated accessor properties to have a different type
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.4k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔍 Search Terms
I was pretty sure an issue already existed for this, but I couldn't find it. Hopefully opening a new issue (to maybe be closed again) will improve SEO.
Here is what I searched for:
- decorators change type
- decorators accessor type
- decorators change type accessor
I did find this related issue:
✅ 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
Allow decorator's return type, ClassAccessorDecoratorResult to specify a different Value-type than what is on the right-hand side of the equals.
Here is how TS 5.6.3 handles this situation today.
📃 Motivating Example
For example, it should be possible to author this with 0 errors:
class Demo {
@unwrap accessor num = { wrapped: 2 };
// ^? => number
get usage() {
expectTypeOf(this.num).toEqualTypeOf<number>();
}
}
💻 Use Cases
- Reactivity
- Hiding complex behaviors from the user
- Unwrapping private objects into public API (the example in the playground link)
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 with the linked TypeScript playground and related issue #52559 to compare current behavior and prior discussion. Use the motivating Demo example as the acceptance case; done means it type-checks with this.num inferred as number while preserving existing runtime behavior.
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
- 35/100