microsoft / microsoft/TypeScript
Co-dependency of variables destructured from union types is lost unless used in control-flow statements
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.4k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔎 Search Terms
destructuring union type tuple
Please expand this list or edit the title with a better-fitting description.
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about n/a
⏯ Playground Link
💻 Code
declare const val1: readonly ['a', 'a'] | readonly ['b', 'b'];
// ^?
const [v1, v2] = val1;
const val2 = [v1, v2] as const;
// ^?
// Is no longer readonly ["a", "a"] | readonly ["b", "b"]
🙁 Actual behavior
When destructuring a variable readonly ["a", "a"] | readonly ["b", "b"] into [v1, v2] = val, the compiler is sophisticated enough to retain the dependency of the two when either is used in either an if or even a switch statement:
if(v1 === 'a') {
v2;
// ^?
// TS is smart enough to know that this is "a"
}
When put back together, however, that dependency is lost. For:
declare const val1: readonly ['a', 'a'] | readonly ['b', 'b'];
const [v1, v2] = val1;
const val2 = [v1, v2] as const;
val1 and val2 should be identical, however, val2 is readonly ["a" | "b", "a" | "b"]. Note that this not only applies to tuples, but de- and restructured objects as well.
See this real example of a legitimate use-case and how this affects the code.
🙂 Expected behavior
Just like with
if(v1 === 'a') {
v2;
// ^?
// TS is smart enough to know that this is "a"
}
the compiler should figure out that v1 and v2 depend on each other when combining them with e.g. [v1, v2] and create an according union type of tuples instead of a single tuple with union type members.
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 reproduction and compare the inferred types for val1, the destructured variables, and val2. Trace the compiler's existing control-flow handling for the if and switch examples, then verify that reconstructing the values preserves the correlated union-tuple type, including the referenced object case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100