microsoft / microsoft/TypeScript

Narrowing types with private functions with `this` return type fails

Offen
#44,785 3 Kommentare 1 Reaktion 1 zugewiesene Person Auf GitHub ansehen

@weswigham arbeitet bereits daran.

Seit 01.7.2021.

Needs Investigation Rescheduled
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

Bug Report

I found that a generic type may be evaluated as incompatible while in fact it should be compatible. In my particular case I have a few generic types / classes that have a type argument constrained to MyClass.
I also have a conditional type with a generic argument that is "less" constrained to a union type of MyClass and a different class that has a generic.

// Conditional type with a generic constrained to either MyClass or something else
type ConditionalType<T extends MyClass | string> =
  T extends MyClass ? MyGenericType<T> : T;

In the given constellation I get the following error:

Type 'MyClass & T' does not satisfy the constraint 'MyClass'.
  Property 'fn' is missing in type 'MyClass & T' but required in type 'MyClass'.(2344)

I found that these prerequisites have to be met to reproduce the error:

  1. The class (MyClass) that we constrain the generics arguments to has a function that returns a this type.
    Edit: Or no type annotation, no matter what the inferred type is. Other return type annotations, e.g. : string work.
  2. This function is either protected or private.
🔎 Search Terms

this type, generic, conditional types

🕗 Version & Regression Information
  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about: seems to me that none apply.
⏯ Playground Link

Playground link with relevant code

💻 Code
// The class to constrain to in the generic types
class MyClass {
  constructor(public name: string) {}

  protected fn(): this {
    return this;
  }
}

// A generic type with a type argument constrained to MyClass
type MyGenericType<T extends MyClass> = T;

// Conditional type with a generic constrained to either MyClass or something else
type ConditionalType<T extends MyClass | string> =
  T extends MyClass ? MyGenericType<T> : T;
🙁 Actual behavior

Although the condition in the mapped type constrains the given type to extend MyClass it is not compatible as the type here evaluates to MyClass & T.

🙂 Expected behavior

I would expect that the condition in the type narrows the type as given in the condition.

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.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

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