如何在NestJS/GraphQL的Resolver中使用枚举类型AuthType？

1. 确保AuthType被注册为GraphQL枚举 #

首先检查你的@enum/authEnum.ts文件，必须用registerEnumType将TypeScript枚举转换为GraphQL可识别的枚举类型：

import { registerEnumType } from '@nestjs/graphql';

export enum AuthType {
  GOOGLE = 'google-auth',
  GITHUB = 'github-auth',
  OUTLOOK = 'outlook-auth',
}

// 注册为GraphQL枚举
registerEnumType(AuthType, {
  name: 'AuthType', // 对应GraphQL Schema中的枚举名称
  description: '支持的第三方认证类型',
});

2. 在Resolver中直接作为查询参数使用 #

修改或新增查询方法，将AuthType作为参数类型，NestJS会自动处理GraphQL请求的枚举值解析：

import { Args, Query, Resolver } from '@nestjs/graphql';
import { AuthType } from '@enum/authEnum';
import { AuthSetting } from './auth-setting.entity';
import { AbstractAuthSettingRepository } from './auth.repository';

@Resolver(() => AuthSetting)
export class AuthResolver {
  constructor(private readonly authRepo: AbstractAuthSettingRepository) {}
  
  // 原有根据ID查询的方法
  @Query(() => AuthSetting)
  findAuth(@Args('id') id: string): Promise<AuthSetting | undefined> {
    return this.authRepo.findOne({ id });
  }

  // 新增：根据认证类型查询配置
  @Query(() => [AuthSetting])
  findAuthByType(
    @Args('authType') authType: AuthType, // 直接使用AuthType作为参数类型
  ): Promise<AuthSetting[]> {
    // 此处authType已被解析为枚举值（如'google-auth'），可直接传入仓库查询
    return this.authRepo.find({ where: { authType } });
  }
}

3. 在复合参数（ArgsType）中使用 #

如果需要传递多个参数，可定义一个ArgsType类，将AuthType作为其中一个字段：

// 定义参数类
import { ArgsType, Field } from '@nestjs/graphql';
import { AuthType } from '@enum/authEnum';

@ArgsType()
export class AuthFilterArgs {
  @Field(() => AuthType, { nullable: true }) // 标记为可选的GraphQL枚举字段
  authType?: AuthType;

  @Field({ nullable: true })
  status?: string;
}

然后在Resolver中使用该参数类：

@Query(() => [AuthSetting])
findAuths(
  @Args() filterArgs: AuthFilterArgs,
): Promise<AuthSetting[]> {
  return this.authRepo.find({ where: filterArgs });
}

关键注意事项 #

• 必须通过registerEnumType注册枚举，否则GraphQL无法识别该类型
• 当参数为可选时，需在@Field装饰器中添加{ nullable: true }，同时在TypeScript类型中使用?标记可选
• 解析后的authType参数值会严格匹配枚举定义的字符串（如'google-auth'），无需额外转换

内容的提问来源于stack exchange，提问作者Alpin Cleopatra