microsoft / microsoft/TypeScript
Intersection type in template literal is not reduced to its bare type
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔎 Search Terms
template literal, intersection type
🕗 Version & Regression Information
- This changed between versions 5.0 and 5.1
- This changed in commit or PR #48034 #52345 #54648
⏯ Playground Link
💻 Code
type StringType<K extends string> = K extends string & infer U
? [K, U] extends [U, K]
? {} extends { [P in `${K}`]: unknown }
? 'templateLiteral'
: 'stringLiteral'
: 'string'
: never
type R1 = StringType<string>
// ^? type R1 = "string"
type R2 = StringType<string & { a: 1 }>
// ^? type R2 = "string"
type R3 = StringType<'abc'>
// ^? type R3 = "stringLiteral"
type R4 = StringType<'abc' & { a: 1 }>
// ^? type R4 = "templateLiteral" <-- should be "stringLiteral"
type R5 = StringType<`${number}`>
// ^? type R5 = "templateLiteral"
type R6 = StringType<`${number}` & { a: 1 }>
// ^? type R6 = "templateLiteral"
🙁 Actual behavior
type R = `${'abc' & { a: 1 }}`
// did not reduce => `${'abc' & { a: 1 }}`
🙂 Expected behavior
type R = `${'abc' & { a: 1 }}`
// should reduce to => `${'abc'}`
// => `abc`
Additional information about the issue
I mentioned this in #54648 after it is closed. It is limiting our ability to write the types that works with string literal and template literal and there is no alternative way to workaround that.
I'm suggesting this issue should be fixed and restore the behavior in 5.0.
Here is my original comment:
This behavior is causing a few types in type-plus to fail (e.g. IsTemplateLiteral, IsStringLiteral, Omit, IsNegative, etc) https://github.com/unional/type-plus/issues/429.
In term of soundness, IMO it does make sense that ${string & { a: 1 }} to be reduced to ${string}.
in JS, it would be:
const extendedStr = Object.assign('abc', { a: 1 })
console.log(`${extendedStr}`) // 'abc'
the reasoning being the toString(): string remains unchanged thus the resulting type should be safe to reduce.
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
Reproduce the regression in the linked TypeScript Playground, comparing the shown R4 and R6 results across versions 5.0 and 5.1. Use the cited commits and pull requests (#48034, #52345, and #54648) as the starting history; done means R4 reduces to the string-literal result while the other examples retain their expected classifications.
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