为 GraphQL 输出解析自动生成的 typescript-mongodb 类型
Resolving auto-generated typescript-mongodb types for GraphQL output
我正在使用 typescript-mongodb
插件到 graphql-codegen
来生成用于从 MongoDB 中提取数据并通过 Node 上的 GraphQL 输出数据的 Typescript 类型。
我的输入 GraphQL 架构如下所示
type User @entity{
id: ID @id,
firstName: String @column @map(path: "first_name"),
...
生成的输出 Typescript 类型看起来正确
export type User = {
__typename?: 'User',
id?: Maybe<Scalars['ID']>,
firstName?: Maybe<Scalars['String']>,
...
以及对应的DB对象
export type UserDbObject = {
_id?: Maybe<String>,
first_name: Maybe<string>,
...
问题是当实际将 mongo 文档作为 UserDbObject
发回时,我没有在输出中得到映射的字段。我可以编写一个自定义解析器,将字段重新映射回 User
类型,但这意味着我要在两个不同的地方映射字段。
即我没有从这样的解析器中获取映射字段
userById: async(_root: any, args: QueryUserByIdArgs, _context: any) : Promise<UserDbObject> => {
const result = await connectDb().then((db) => {
return db.collection<UserDbObject>('users').findOne({'_id': args.id}).then((doc) => {
return doc;
});
})
...
return result as UserDbObject;
}
};
有没有办法使用 typescript-mongodb
插件只需要在架构中映射这些字段,然后使用自动生成的代码来解析它们?
您可以使用 codegen 的 mappers
功能在 GraphQL 类型和模型类型之间进行映射。
参见:
- https://graphql-code-generator.com/docs/plugins/typescript-resolvers#mappers---overwrite-parents-and-resolved-values
- https://graphql-code-generator.com/docs/plugins/typescript-resolvers#mappers-object
由于所有 codegen 插件都是独立的,没有链接在一起,您应该手动完成,例如:
config:
mappers:
User: UserDbObject
这将使 typescript-resolvers
插件随时使用 UserDbObject
(作为父值,或作为 return 值)。
如果您希望自动执行此操作,您可以以编程方式使用代码生成器 (https://graphql-code-generator.com/docs/getting-started/programmatic-usage),或者您也可以创建一个 .js
文件而不是 .yaml
文件来创建根据您的需要配置部分。
我正在使用 typescript-mongodb
插件到 graphql-codegen
来生成用于从 MongoDB 中提取数据并通过 Node 上的 GraphQL 输出数据的 Typescript 类型。
我的输入 GraphQL 架构如下所示
type User @entity{
id: ID @id,
firstName: String @column @map(path: "first_name"),
...
生成的输出 Typescript 类型看起来正确
export type User = {
__typename?: 'User',
id?: Maybe<Scalars['ID']>,
firstName?: Maybe<Scalars['String']>,
...
以及对应的DB对象
export type UserDbObject = {
_id?: Maybe<String>,
first_name: Maybe<string>,
...
问题是当实际将 mongo 文档作为 UserDbObject
发回时,我没有在输出中得到映射的字段。我可以编写一个自定义解析器,将字段重新映射回 User
类型,但这意味着我要在两个不同的地方映射字段。
即我没有从这样的解析器中获取映射字段
userById: async(_root: any, args: QueryUserByIdArgs, _context: any) : Promise<UserDbObject> => {
const result = await connectDb().then((db) => {
return db.collection<UserDbObject>('users').findOne({'_id': args.id}).then((doc) => {
return doc;
});
})
...
return result as UserDbObject;
}
};
有没有办法使用 typescript-mongodb
插件只需要在架构中映射这些字段,然后使用自动生成的代码来解析它们?
您可以使用 codegen 的 mappers
功能在 GraphQL 类型和模型类型之间进行映射。
参见:
- https://graphql-code-generator.com/docs/plugins/typescript-resolvers#mappers---overwrite-parents-and-resolved-values
- https://graphql-code-generator.com/docs/plugins/typescript-resolvers#mappers-object
由于所有 codegen 插件都是独立的,没有链接在一起,您应该手动完成,例如:
config:
mappers:
User: UserDbObject
这将使 typescript-resolvers
插件随时使用 UserDbObject
(作为父值,或作为 return 值)。
如果您希望自动执行此操作,您可以以编程方式使用代码生成器 (https://graphql-code-generator.com/docs/getting-started/programmatic-usage),或者您也可以创建一个 .js
文件而不是 .yaml
文件来创建根据您的需要配置部分。