microsoft / microsoft/TypeScript

Make it possible to infer superclass type parameters / constructor overload from the `super` call

オープン
#36,456 コメント 14 件 リアクション 37 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Awaiting More Feedback Suggestion
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
2日 4時間
マージ済み PR(30日)
132

説明

Search Terms

superclass base class generic type infer contextual infer parent generic super constructor

Suggestion

Make it possible to infer superclass type parameters / constructor overload from the super call

Use Cases

I'm working on an intermediate library with typings for a legacy codebase. That intermediate library is used in third party to use the functionality from the main codebase (called adapters). There are several supported ways to access this functionality:

  1. const foo1 = Adapter(options);
  2. const foo2 = new Adapter(options);
  3. class Foo3 extends Adapter { ... } - The constructor must call the superclass constructor with the options.

Now the problem is that the Adapter "class" (actually an ES5-style "function" class) has some properties that only exist if specific options are passed to its constructor. I'm able to model this behavior for case 1 and 2, but not 3 - at least not without manually specifying the type.

Here's what I have so far. The code is split into three parts: main codebase, intermediate library, 3rd party / user code. (Playground link)

// legacy code, cannot change:
declare class InternalAdapter {
    // actually an ES5-style class function, can be called with and without new!
    someProp1: any;
    someProp2: any;

    // I want to override this type
    cacheObj: Record<string, any> | undefined;
}

// ========================

// My code, can change:
interface AdapterOptions {
    name: string;
    cache?: boolean;
}

type AdapterInstance<T extends AdapterOptions> = T extends {
	cache: true;
}
	? Omit<InternalAdapter, "cacheObj"> & {
			cacheObj: Exclude<InternalAdapter["cacheObj"], undefined>;
	  }
	: Omit<InternalAdapter, "cacheObj">;

interface AdapterConstructor {
	new (adapterName: string): AdapterInstance<{name: string}>;
	new <T extends AdapterOptions>(adapterOptions: T): AdapterInstance<T>;
    
	(adapterName: string): AdapterInstance<{name: string}>;
	<T extends AdapterOptions>(adapterOptions: T): AdapterInstance<T>;
}

declare const Adapter: AdapterConstructor;

// ========================

// User code, should be as simple as possible
const name = "foobar";
const options = { name };

const test1 = Adapter(name);
test1.cacheObj; // does not exist, expected

const test2 = new Adapter(name);
test2.cacheObj; // does not exist, expected

const test3 = Adapter(options);
test3.cacheObj; // does not exist, expected

const test4 = new Adapter(options);
test4.cacheObj; // does not exist, expected

const test5 = new Adapter({ ...options, cache: true });
test5.cacheObj; // exists, expected

// Here, the problems start:

class Test6 extends Adapter<AdapterOptions> {
    constructor(options: AdapterOptions) {
        super(options);
        this.cacheObj; // does not exist, expected
    }
}

class Test7 extends Adapter<AdapterOptions> {
    constructor(options: AdapterOptions) {
        super({ ...options, cache: true });
        this.cacheObj; // does not exist, unexpected
    }
}

class Test8 extends Adapter<AdapterOptions & {cache: true}> {
    constructor(options: AdapterOptions) {
        super({ ...options, cache: true });
        this.cacheObj; // exists, but I have to duplicate the type
    }
}

Notice how the class definitions are all awkward. In Test6 I have to duplicate the generic type AdapterOptions or the super call will default to the string constructor.
In Test7 this is actually wrong, because the generic type overrides the conditional behavior for the cacheObj. This can be fixed like in Test8, but that is really ugly. IMO, TypeScript should be able to infer the type arguments from a constructor call if that type argument matches the class' type argument

Examples

Show how this would be used and what the behavior would be - Ideally it should be like this:

class Test9 extends Adapter {
    constructor(options: AdapterOptions) {
        super({ ...options, cache: true });
        this.cacheObj; // should exist
    }
}

The super call would be used to infer that the 2nd constructor overload is the correct one:

new <T extends AdapterOptions>(adapterOptions: T): AdapterInstance<T>;

and therefore the instance type would be AdapterInstance<AdapterOptions & {cache: true}>.

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code (not sure actually. I'd guess not?)
  • 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, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

リンクされている TypeScript Playground から始めて、Test6–Test9 の例を比較し、super 呼び出しがどのようにコンストラクターのオーバーロードを選択し、サブクラスのインスタンスタイプを決定するかに注目してください。Test9 の望ましい形式が super({ ...options, cache: true }) から options の型を推論し、ジェネリック型を重複させずに cacheObj を利用できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
compilers
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
32/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。