microsoft / microsoft/TypeScript
Generic type narrowing for truthy check has inconsistent / incorrect behavior
@ahejlsberg is already working on this.
Since Aug 30, 2024.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔎 Search Terms
generic truthy narrowing generic index
🕗 Version & Regression Information
This is the behavior in every version I tried, and I reviewed the FAQ for entries about narrowing truthy generic types
⏯ Playground Link
💻 Code
const record: Record<string, unknown> = {};
function foo<T extends string | false | null>(val: T) {
if (val) {
val;
//^?
bar(val);
record[val] = 5;
} else {
val
//^?
}
}
function foo2(val: string | false | null) {
if (val) {
val;
//^?
bar(val);
record[val] = 5;
} else {
val
//^?
}
}
function bar(val: string) {
return val;
}
🙁 Actual behavior
Error on line 8, cannot use val to index object type with string key.
Val appears to be narrowed to NonNullable<T> yet I can use it as string when calling functions?
Note: foo2 does not use generics and has more expected bahavior.
🙂 Expected behavior
type Falsy = false | null | undefined | 0 | "";
(might remove 0 | "" from this because that gets into negated types... false seems like a common enough one to matter though)
On line 5 inside of the if check, I expect val to be narrowed to Exclude<T, Falsy> but instead, is incorrectly (imo) narrowed to NonNullable<T> which does not exclude false.
What is exceptionally strange, is that the type narrowing behavior seems to differ depending on how val is used. I can pass it to the function that takes a string parameter, but when I try to use it to index an object on line 8, I get an error.
Additional information about the issue
This issue was discussed in detail by others more experienced than me in this typescript discord thread:
https://discord.com/channels/508357248330760243/1275942751724372110
Invite to server if you aren't a member:
https://discord.com/invite/typescript
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.