microsoft / microsoft/TypeScript
TS 3.7: unlike `x is T`, `asserts x is T` cannot close over generics defined in outer scopes
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.7.0-dev.20191016
Search Terms:
asserts, asserts return, asserts higher order, asserts type, 2775
Code
function literal<T extends keyof any>(lit: T): {
is(value: any): value is T
assert(value: any): asserts value is T
} {
return null as any; // implementation doesn't matter
}
const isHi = literal("hi")
const x: unknown = "test"
if (isHi.is(x)) {
console.log(x) // x is correctly inferred to be 'hi' :)
}
isHi.assert(x); // error: Assertions require every name in the call target to be declared with an explicit type annotation.(2775)
console.log(x); // x should be inferred to be 'hi' here :(
Expected behavior:
No compile error, x is inferred to be "hi" on the last line.
Actual behavior:
Compile error on isHi.assert. Assertions require every name in the call target to be declared with an explicit type annotation.(2775)
Construction higher order type guards is possible without problem (as shown in the snippet). This mechanism used heavily in libraries like io-ts and mobx-state-tree.
However, when trying to extend the latter library with assertion functionality for more convenient control flow, we run into this issue.
We can build type.is properly, but not type.assert, although they seem to be needing the exact same type / depth of type analysis; if type guards can close over T, so should type assertions?
Playground Link: link
Related Issues:
#34523
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 review related issue #34523, confirming diagnostic 2775 for the higher-order assertion example. The work is done when the example compiles without that error and the final use of x is inferred as "hi".
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