microsoft / microsoft/TypeScript
Surprising excess property check with recursive generic constraint
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔎 Search Terms
excess property check recursive generic contraint type variable inference
🕗 Version & Regression Information
- This is the behavior in every version I tried
⏯ Playground Link
💻 Code
type StateSchema = {
states?: Record<string, StateSchema>;
};
declare function createMachine<TConfig extends StateSchema>(
config: TConfig,
): TConfig;
createMachine({
entry: [{ type: "foo" }],
states: {
a: {
entry: [{ type: "bar" }],
},
},
});
🙁 Actual behavior
At the nested entry property the error is raised:
Object literal may only specify known properties, and 'entry' does not exist in type 'StateSchema'.(2353)
but it isn't raised at the entry property at the root of this object.
🙂 Expected behavior
I'd expect no excess property error to be raised with a recursive constraint like this.
Additional information about the issue
This particular case is somewhat easily fixable by adding [k: string]: unknown to StateSchema. I still find the reported behavior to be a problem though.
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 opening the linked TypeScript Playground reproduction and tracing the excess-property check for the root and nested entry properties under the recursive StateSchema constraint. Done means the nested case no longer reports diagnostic 2353, consistently with the stated expected behavior; the issue names no repository file or test.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 42/100