在打字稿中反映和映射键入的参数形状?

时间:2019-01-05 19:39:55

标签: typescript codegen

上下文

我正在尝试构建一个Codegen工具。我喜欢使用GraphQL,但是,当我拥有完整的堆栈时,前端使用字符串定义的gql查询调用后端似乎有点可笑。 GQL是强类型的,因此我应该能够提供强类型的查询和响应。

问题

我不知道如何构建接口,以便可以递归地反映和映射参数从输入类型到目标类型。具体来说,我想将查询请求类型映射为gql查询响应类型。

const query: QueryRequest<Food.IFood> = {
  name: true // true ==> implies inclusion in response
}
const res = await client.food(query)
console.log(res.name) // PASS - should compile
console.log(res.nodeId) // FAIL - should not compile. `nodeId` was not present in query

// Food.IFood is a TS interface, representative of my GQL schema.  GQL => TS interfaces is a solved codegen problem already
// ref: https://github.com/cdaringe/gql-ts-client-codegen/blob/master/src/__tests__/fixture/namespace.ts
  • QueryRequest<T>(不完全)将我的Food.IFood界面映射为新类型,其中键映射为布尔值,表示包含GQL字段
  • 但是,每个客户端方法都需要嗅探传递通过的QueryRequest<T>以获得显式形状,并以某种方式将该显式形状映射到Partial<Food.IFood>上。
    • 请教我,我 不想要PartialPartial对于存在哪些字段是模棱两可的。我希望客户的响应具有明确的字段成员身份,作为输入的函数。

我了解到,我对GQL客户的上述说明在很大程度上已过分简化,并且免除了遵守所有GQL功能所需的其他复杂性。很好,很好。我在这篇文章中的主要目的是严格地看是否有一种方法可以执行这种反映类型映射。

我已经开始草拟一个硬编码的 target client.ts文件,以获取可能的输出结果:https://github.com/cdaringe/gql-ts-client-codegen/blob/master/src/target.ts

任何输入将不胜感激!谢谢。

1 个答案:

答案 0 :(得分:2)

不幸的是,您想要的基本上是限制变量的类型,而同时让编译器来推断该变量的类型。不幸的是,这不可能直接实现。

实现所需行为的唯一方法是使用函数。函数可以具有泛型类型参数,并具有约束,但是最终类型参数将从传入的实际对象文字中推断出来:

magic-name

type QueryRequest<T, K extends keyof T> = { keys: Record<K, boolean> } function buildQueryRequest<T>() { return function <P extends keyof T> (o:Partial<Record<P, boolean>>) : QueryRequest<T, P>{ return null!; } } interface IFood { name: string; nodeId: number; } type QueryResult<T, K extends keyof T> = Pick<T, K> declare class Client { food<K extends keyof IFood>(q: QueryRequest<IFood, K>) : Promise<QueryResult<IFood, K>> } (async function (client: Client) { const query = buildQueryRequest<IFood>()({ name: true // true ==> implies inclusion in response }) const res = await client.food(query) console.log(res.name) // PASS - should compile console.log(res.nodeId) // error }) 是一个函数,该函数返回一个函数(即一个咖喱函数),以便允许指定第一个参数,并推断出第二个参数,