microsoft / microsoft/TypeScript
[Feature Request] Non-Union Generic Type Params
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 132
説明
Search Terms
- non-union
- generic
- type param
- one of
Suggestion
A way to annotate that a generic type param will not accept union types.
I don't have the syntax or keyword in mind, but I'll just go ahead and use nonUnion as a kind of type param modifier,
type NonUnionX<nonUnion T> = (
/*Implementation*/
);
Use Cases
What do you want to use this for?
I work with pretty complex types (in my opinion); and a lot of them.
When working on a complex type, I tend to break the problem down into smaller subproblems.
The base case is usually assuming that all type params are non-union.
After that, I build on top of the base case and implement types that support union type params.
Here is an example type that is a base case,
PrimaryKey_NonUnion<TableT>
And here is an example of a type building upon the base case,
PrimaryKey_Output<TableT>
It distributes TableT and uses PrimaryKey_NonUnion. The result is a union if TableT is a union.
And here is an example of another type building upon the base case,
PrimaryKey_Input<TableT>
It distributes TableT and uses PrimaryKey_NonUnion.
Then, it uses UnionToIntersection<> to combine the results into one type.
That experimental repository of mine is filled with instances of generic types that support union types and those that do not.
There are times where you really do not want to pass a union type to a generic type param because it'll result in bugs that may not be noticed till later.
What shortcomings exist with current approaches?
One approach is to just write a comment that says,
/**
* + Assumes `T` is not a union
* + Assumes `U` may be a union
* + Assumes `V` is not a union
*/
This gets very error-prone when you start having hundreds of types.
Another approach is to give your types names that are descriptive,
type SomeOperation_NonUnionT_UnionU_NonUnionV<
T,
U,
V
> = (
//Implementation
);
This is still error-prone; you may still use it incorrectly.
Even if the name of the type says NonUnionT, you may still pass a union type to T.
Examples
type NonUnionX<nonUnion T> = (
/*Implementation*/
);
//OK
type nonUnionX1 = NonUnionX<string>;
//Error, Type `NonUnionX` expects non-union for type parameter `0`
// `string|number` is a union type
type nonUnionX2 = NonUnionX<string|number>;
// ~~~~~~~~~~~~~
type UnionX<T> = (
T extends any ?
//OK! `T` has been distributed
NonUnionX<T> :
never
);
//OK
type unionX1 = UnionX<string>;
//OK
type unionX2 = UnionX<string|number>;
type Blah<T> = (
//Error, Type `NonUnionX` expects non-union for type parameter `0`
// `T` may be a union type
NonUnionX<T>
// ~
);
A non-approach is to expose only types that handle union type params and to leave non-union implementations unexported.
This is not a useful approach because it means building new types in a different file using these non-union implementations becomes impossible. Since they're unexported.
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- 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.
Similar issues
https://github.com/microsoft/TypeScript/issues/24085
https://github.com/microsoft/TypeScript/issues/27808
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず提案されている例と関連する issue 24085 および 27808 を確認し、次に src/primary-key/primary-key.ts で参照されている tsql の例を調べます。完了の条件は、ジェネリックパラメーターが union 型を拒否しながら、示されている distributive パターンを引き続き許可できることです。構文とコンパイラー設計は未指定のままです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100