microsoft / microsoft/TypeScript
Generic enumerated type parameter narrowing (conditional types)
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 132
説明
Search Terms
conditional type inference enum enumerated narrowing branching generic parameter type guard
Suggestion
Improve inference / narrowing for a generic type parameter and a related conditional type.
I saw another closed-wontfix issue requesting generic parameter type guards, but a type guard should not be necessary for this case, since the possible values for the generic are enumerated.
Use Cases
(Names have been changed and simplified)
I have a method that takes a KeyType (enumerated) and a KeyValue with type conditionally based on the enumerated KeyType.
Depending on the KeyType value, the code calls method(s) specific to that type.
The TS compiler is unable to tell that after I have checked the enumerated KeyType, the type of the KeyValue (string, number, etc) is known and should be able to be passed to a function that only accepts that specific KeyValue type.
Examples
const enum TypeEnum {
String = "string",
Number = "number",
Tuple = "tuple"
}
// The issue also occurs with
// type TypeEnum = "string" | "number" | "tuple"
interface KeyTuple { key1: string; key2: number; }
type KeyForTypeEnum<T extends TypeEnum>
= T extends TypeEnum.String ? string
: T extends TypeEnum.Number ? number
: T extends TypeEnum.Tuple ? KeyTuple
: never;
class DoSomethingWithKeys {
doSomethingSwitch<TType extends TypeEnum>(type: TType, key: KeyForTypeEnum<TType>) {
switch (type) {
case TypeEnum.String: {
this.doSomethingWithString(key);
break;
}
case TypeEnum.Number: {
this.doSomethingWithNumber(key);
break;
}
case TypeEnum.Tuple: {
this.doSomethingWithTuple(key);
break;
}
}
}
doSomethingIf<TType extends TypeEnum>(type: TType, key: KeyForTypeEnum<TType>) {
if (type === TypeEnum.String) {
this.doSomethingWithString(key);
}
else if (type === TypeEnum.Number) {
this.doSomethingWithNumber(key);
}
else if (type === TypeEnum.Tuple) {
this.doSomethingWithTuple(key);
}
}
private doSomethingWithString(key: string) {
}
private doSomethingWithNumber(key: number) {
}
private doSomethingWithTuple(key: KeyTuple) {
}
}
This should compile without errors if TS was able to tell that the switch statements or equality checks limited the possible type of the other property.
I lose a lot of the benefits of TS if I have to cast the value to something else. especially if I have to cast as any as KeyForTypeEnum<TType> as has happened in my current codebase.
If I'm doing something wrong or if there's already a way to handle this, please let me know.
Checklist
My suggestion meets these guidelines:
[X] This wouldn't be a breaking change in existing TypeScript / JavaScript code
[X] This wouldn't change the runtime behavior of existing JavaScript code
[X] This could be implemented without emitting different JS based on the types of the expressions
[X] This isn't a runtime feature (e.g. new expression-level syntax)
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、提供されているジェネリックな条件型の例を再現し、ジェネリックな narrowing と条件型に関する TypeScript コンパイラの既存のテストを見つけてください。この issue では特定のファイルやテストは指定されていません。既存の動作を維持したまま、同等の switch 分岐と等価性チェックの分岐が casts なしでコンパイルできれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 28/100