Pick嵌套型TypeScript

Question

我有一个从Swagger定义中生成的类型。

每个API端点的API响应嵌套在端点类型中。目前，我访问的内容如下：

type Endpoint1Return = Endpoints['/endpoint1']['get']['responses']['200']['content']['application/json']
type Endpoint2Return = Endpoints['/endpoint2']['get']['responses']['200']['content']['application/json']

我想要一个实用工具类型来为每个端点选择嵌套的application/json键。类似于：

type Endpoint1Return = PickEndpoint<'/endpoint1'>

这很困难，因为TS不知道Endpoints的每个键对于get、responses、200等都有相同的子键。

有人能想出一种表达这一点的方法吗？

Answer 1

考虑到您最新的问题，我认为这是TypeScript中的一个bug，正如微软/打字稿#27709中所报告的那样。编译器似乎没有正确计算嵌套的泛型查找类型 (如Endpoints[K][L]["responses"] )的约束。正如您注意到的那样，子属性查找类型似乎把事情搞砸了：

type PickEndpointWithMethod<K extends keyof Endpoints, L extends keyof Endpoints[K]> =
    Endpoints[K][L]['responses']['200']['content']['application/json']; // error!
// Type '"responses"' cannot be used to index type 'Endpoints[K][L]'.
// Type '"200"' cannot be used to index type 'Endpoints[K][L]["responses"]'.
// Type '"content"' cannot be used to index type 'Endpoints[K][L]["responses"]["200"]'.
// Type '"application/json"' cannot be used to index type 
//   'Endpoints[K][L]["responses"]["200"]["content"]'.

这个错误似乎没有计划在短期内修复。

作为解决办法，您可以自己计算索引访问的约束，并使用实用程序类型向编译器提示查找类型确实满足该约束：

type Idx<T, K extends keyof T> = Extract<T[K], T extends any ? T[keyof T] : never>;

在这里，我们向编译器保证，T[K]将扩展T[keyof T]，即使T是事物的统一体。( T extends any ? T[keyof T]: never构造使用分布条件类型这样做)。然后我们可以将Endpoints[K][L]替换为Idx<Endpoints[K], L>，如下所示：

type PickEndpointWithMethod<K extends keyof Endpoints, L extends keyof Endpoints[K]> =
    Idx<Endpoints[K], L>['responses']['200']['content']['application/json']; // okay

让我们看看它是否有效：

type Endpoint1Return = PickEndpointWithMethod<'/endpoint1', 'get'>
// type Endpoint1Return = "https://example.com/foo"
type Endpoint2Return = PickEndpointWithMethod<'/endpoint2', 'post'>
// type Endpoint2Return = "https://example.com/bar"

看起来不错！

操场链接到代码