microsoft / microsoft/TypeScript

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

Open
#44,785 3 comments 1 reaction 1 assignee View on GitHub

@weswigham is already working on this.

Since Jul 1, 2021.

Needs Investigation Rescheduled
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

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.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.