microsoft / microsoft/TypeScript

Discriminated union narrowing fails when use template literal types as tag

Offen
#42,007 3 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Awaiting More Feedback Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

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:

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der verknüpften TypeScript Playground-Reproduktion und der generischen Funktion f und konzentriere dich darauf, wie der switch über oneOrTwoObj.type Template-Literal-Typen behandelt. Bestätige das aktuelle Verhalten und verfolge anschließend den Type-Checking-Pfad für die Narrowing von Discriminated Unions. Fertig ist die Untersuchung, wenn jeder switch-Zweig oneOrTwoObj auf das entsprechende OneObj oder TwoObj eingrenzt, sodass die Aufrufe von acceptsOneObj und acceptsTwoObj den Type-Check bestehen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.