microsoft / microsoft/TypeScript
exactOptionsPropertyTypes - anomolous behavior with Tuples, options, and spreading.
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.4k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
Bug Report
🔎 Search Terms
- strictOptionalProperties #43947 #44548
- exactOptionalPropertyTypes
- Labelled Tuple Elements
- Optional Tuple Parameters (enabled with labeling)
- Variadic Tuple Types
🕗 Version & Regression Information
-
Spreading of Variadic Tuple types, as well as the ability to indicate final position optional parameters with labels, were introduced in ts 4.0. The noted behavior has been been present since then.
-
However, although there was hope it would be fixed with 4.4's exact
exactOptionsParameters, it was not.
⏯ Playground Link
💻 Code
type T1 = [x:number, x?:boolean]
const t11:T1 = [1,undefined] // EXCELLENT!! with exactOptionalPropertyTypes:true this became is an error.
const t12:T1 = [1,true]
const t13:T1 = [1]
type T2 = ['^',...T1,'$']
const t21:T2 = ['^',1,true,'$'];
const t22:T2 = ['^',1,undefined,'$']; // noerr - CLAIM - this SHOULD be an error
const t23:T2 = ['^',1,'$']; // err - CLAIM - this SHOULD NOT be an error
🙁 Actual behavior
In the above code, variable declaration for t22 is NOT an err.
In the above code, variable declaration for t23 IS an err.
🙂 Expected behavior
In the above code, variable declaration for t22 IS an err.
In the above code, variable declaration for t23 is NOT an err.
Even though with exactOptionalPropertyTypes , the T1 now no longer considers [number,undefined] to be a legal assignment, when T1 is spread into T2 the old behavior is used instead of the new behavior.
The documentation for exactOptionalPropertyTypes says
In TypeScript 4.4, the new flag --exactOptionalPropertyTypes specifies that optional property types should be interpreted exactly as written, meaning that
| undefinedis not added to the type:
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 using exactOptionalPropertyTypes and the T1/T2 tuple assignments. Investigate how optional tuple elements behave when variadic tuples are spread, then verify that t22 is rejected and t23 is accepted while the existing T1 checks remain correct.
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
- 35/100