microsoft / microsoft/TypeScript
Conditionally Mapped Type Leads to Confusing ts(2345) Error Message
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version:
3.9.6
4.1.0-dev.20200914
Search Terms:
2345
conditional
Code
declare type GetPropertyNamesOfType<T, RestrictToType> = {
[K in keyof T]: T[K] extends RestrictToType ? K : never;
}[keyof T];
You can find this gnarly type here:
https://github.com/microsoft/TypeScript/blob/94d4023043dd032a8c96a59677eb63526b6b24b6/tests/cases/conformance/types/conditional/conditionalTypes2.ts#L227
The following consuming/using code correctly generates ts(2345) errors for the last two lines:
interface A {
req: string;
num: number;
str: string;
}
interface B {
req: string;
num?: number;
str?: string;
}
declare function callA(name: GetPropertyNamesOfType<A, string>): void;
declare function callB(name: GetPropertyNamesOfType<Required<B>, string>): void;
const prop = "someKey";
callA(prop); // ts(2345)
callB(prop); // ts(2345)
Expected behavior:
In typescript@3.9.5 & typescript@3.8 (and a few earlier versions I tried) the error message for both lines is:
Argument of type '"someKey"' is not assignable to parameter of type '"req" | "str"'.
Actual behavior:
In typescript@^3.9.6 this is reported for both lines:
Argument of type '"someKey"' is not assignable to parameter of type 'GetPropertyNamesOfType<A, string>'.
That's correct (nice even!) for the callA() line, but it's confusing for the callB() line.
(This reproduction is a single file that can run into this problem... it's not how I ran into it. I had a ts.Program with many 10s of *.ts files in the same compilation and the message was referring to some type that made no sense in the source file that was giving me the error.)
Related Issues:
I found reference to the gnarly type above in #32608 & #33568.
It looks to be the same "monster" as you see in #29505 too.
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 reproduction in the issue and the referenced tests/cases/conformance/types/conditional/conditionalTypes2.ts around line 227; compare diagnostics in the listed TypeScript versions and the Playground link. Done means the callB error no longer presents a misleading conditional mapped type while retaining the expected ts(2345) diagnostic.
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
- Mostly clear
- Newbie friendliness
- 38/100