microsoft / microsoft/TypeScript

instanceof narrowing should use InstanceType

Open
#55,241 0 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
1d 19h
Merged PRs (30d)
117

Description

Suggestion

🔍 Search Terms

instanceof, narrow, generic, typeof

✅ Viability Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code. (Stronger narrowing logic can result in additional errors being emitted.)
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

value instanceof SomeClass narrows value to SomeClass in subsequent flow. However, value instanceof someClass, where someClass is defined as someClass: T and T extends typeof BaseClass, only narrows value to BaseClass rather than InstanceType<T>.

See also #28936, though in this case I'm not referencing constructor at all.

📃 Motivating Example

If you want to downcast in a class hierarchy, you use instanceof. JavaScript's dynamism even allows you to dynamically pick the class to cast to. However, TypeScript doesn't understand that when the class is specified using generics, which prevents you from returning a corresponding instance type.

class Base {
  private readonly field: number;
  constructor(field: number) {
    this.field = field;
  }

  private downcastTo<T extends typeof Base>(subclass: T): InstanceType<T> {
    if (this instanceof subclass)
      return this; // error: Type 'this' is not assignable to type 'InstanceType<T>'
    throw new TypeError(`expected ${subclass.name}, got ${this.constructor.name}`);
  }

  static parse<T extends typeof Base>(this: T, input: string): InstanceType<T> {
    let result: Base;
    if (input == "Sub1") {
      result = new Sub1(1);
    } else if (input == "Sub2") {
      result = new Sub2(2);
    } else {
      throw new TypeError("invalid input");
    }
    return result.downcastTo(this);
  }
}

class Sub1 extends Base {
  // ...
}
class Sub2 extends Base {
  // ...
}

// Normal static method usage
const base: Base = Base.parse("sub1")
// Now also valid, with stronger checks
const sub1: Sub1 = Sub1.parse("sub1");

💻 Use Cases

We are using this for a more realistic version of the example, parsing a serialized format into a type hierarchy. Some callers know that the serialized data should be a specific subclass, and that there should be an error if it doesn't match that subclass, and so it's convenient if the class you call parse on decides the type you get back.

Workarounds:

  • Have parse always return Base, downcast at call sites. Verbose: if (!(result instanceof Sub1)) throw new Error("…").
  • Use a type-predicate wrapper function for instanceof. This works but is unchecked by the compiler, and of course adds a small bit of overhead because the function won't be compiled away.
  • Use as InstanceType<T> to tell TypeScript we know what we're doing. Also works, also unchecked, but probably the workaround I'd recommend for now.

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 by reproducing the motivating TypeScript example and checking how generic instanceof narrowing currently behaves. Trace the compiler's control-flow narrowing and InstanceType handling to determine where the proposed relationship would be modeled, then add focused tests showing the expected narrowing and confirming existing behavior is preserved.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.