microsoft / microsoft/TypeScript

Discriminated union narrowing fails when use template literal types as tag

Open
#42,007 3 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

TypeScript Version: 4.2.0-dev.20201211

Search Terms: narrowing, discriminated union, template literal types

Code

type Types<T extends string> = {
  one: `${T}/one`;
  two: `${T}/two`;
}
type OneObj<T extends string> = {
  type: Types<T>["one"];
  one: string;
}
type TwoObj<T extends string> = {
  type: Types<T>["two"];
  two: string;
}
type OneOrTwoObj<T extends string> = OneObj<T> | TwoObj<T>

declare function acceptsOneObj<T extends string>(oneObj: OneObj<T>): void;
declare function acceptsTwoObj<T extends string>(twoObj: TwoObj<T>): void;

function f<T extends string>(oneOrTwoObj: OneOrTwoObj<T>, types: Types<T>){
  switch(oneOrTwoObj.type){
    case types.one:
     return acceptsOneObj(oneOrTwoObj); // Error: Argument of type 'OneOrTwoObj<T>' is not assignable to parameter of type 'OneObj<T>'.
    case types.two:
     return acceptsTwoObj(oneOrTwoObj); // Error: Argument of type 'OneOrTwoObj<T>' is not assignable to parameter of type 'OneObj<T>'.
  }
}

Expected behavior:
oneOrTwoObj should be narrowed to OneObj or TwoObj in function f

Actual behavior:
narrowing fails

Playground Link:
playground

Related Issues:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked TypeScript Playground reproduction and the generic function f, focusing on how the switch over oneOrTwoObj.type handles template literal types. Confirm the current behavior, then trace the type-checking path for discriminated-union narrowing. Done means each switch branch narrows oneOrTwoObj to the corresponding OneObj or TwoObj so the acceptsOneObj and acceptsTwoObj calls type-check.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.