microsoft / microsoft/TypeScript
Removing optional modifier in homomorphic mapped types does not work in generic contexts since 5.5.x
@ahejlsberg is already working on this.
Since Sep 9, 2024.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
🔎 Search Terms
optional modifier, required fields, generic, NonNullable, strictNullChecks, homomorphic mapped types
🕗 Version & Regression Information
- This changed between versions 5.4.5 and 5.5.2
- This changed in commit or PR e418f8d12c5f1b6c10fc3127764f34dad44d4586 (as reported by
every-ts)
⏯ Playground Link
💻 Code
const example = <T extends string>(): any => {
// Replacing with any specific sub-type of `string` makes the types correct again.
// type T = string;
type SomeOptional = { [key in T]?: 1 };
type AllRequired = { [key in keyof SomeOptional]-?: 1 };
type RequiredValues = AllRequired[keyof AllRequired];
// Complains in 5.4.x, but fine in 5.5.x
const x: RequiredValues = undefined
return x;
};
🙁 Actual behavior
Using -? leaves the fields marked as optional, and taking the values of the resulting type gives a union with undefined.
🙂 Expected behavior
Using -? makes all fields required, and taking the values of the resulting type gives a union of field types.
Additional information about the issue
Requires a --strictNullChecks flag.
Replacing keyof SomeOptional with NonNullable<keyof SomeOptional> or keyof SomeOptional as keyof SomeOptional fixes the issue. It looks like this problem is limited to homomorphic mapped types.
Using Required<{ [P in keyof SomeOptional]: 1; }> in place of { [key in keyof SomeOptional]-?: 1 } results in the same behaviour.
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.
Assessment
This issue has not been assessed yet.