如何在NestJS的TypeORM中正确为PostgreSQL返回值定义类型

1. 为什么返回类型没有推断出| null？ #

TypeORM的findOneBy、QueryBuilder.getOne()这类方法的原生类型定义是返回Promise<T | null>，但如果你的TypeScript配置中strictNullChecks设为false，TypeScript会自动忽略null类型，导致推断结果仅为Promise<UserEntity>。

解决办法：检查tsconfig.json，确保strictNullChecks设置为true，这样TypeScript会正确识别可能的null返回值。

2. TypeORM能否自动推断部分字段的返回类型？ #

不能。因为字段选择（比如select数组、QueryBuilder的select方法）是运行时逻辑，而TypeScript是编译时类型系统，无法自动感知运行时的字段过滤结果，所以必须手动定义返回类型。

推荐的类型定义方案 #

方案A：使用Omit工具类型快速生成精简类型

利用TypeScript的Omit工具，从UserEntity中排除敏感字段：

// 定义公开用户类型（排除password和refreshToken）
type PublicUser = Omit<UserEntity, 'password' | 'refreshToken'>;

然后在Service方法中明确指定返回类型，并通过类型断言告诉TypeScript实际返回结构：

findAllUsers(): Promise<PublicUser[]> {
  return this.usersRepository.find({
    select: ['id', 'email', 'name'],
  }) as Promise<PublicUser[]>;
}

findUserById(id: number): Promise<PublicUser | null> {
  return this.usersRepository
    .createQueryBuilder('user')
    .select(['user.id', 'user.email', 'user.name'])
    .where('user.id= :userId', { userId: id })
    .getOne() as Promise<PublicUser | null>;
}

// 明确findUserByEmail的返回类型（包含完整字段+可能的null）
findUserByEmail(email: string): Promise<UserEntity | null> {
  return this.usersRepository.findOneBy({ email });
}

方案B：创建独立的公开用户DTO/接口

如果需要在控制器等其他地方复用这个精简结构，推荐单独定义DTO：

// src/users/dto/public-user.dto.ts
export class PublicUserDto {
  id: number;
  email: string;
  name: string;
}

然后在Service中使用这个DTO作为返回类型：

findUserById(id: number): Promise<PublicUserDto | null> {
  return this.usersRepository
    .createQueryBuilder('user')
    .select(['user.id', 'user.email', 'user.name'])
    .where('user.id= :userId', { userId: id })
    .getOne() as Promise<PublicUserDto | null>;
}

不推荐的方案：给实体字段加可选

不要给UserEntity的password、refreshToken加?设为可选字段，这会破坏实体本身的类型严谨性（比如创建用户时password是必填项），导致后续业务逻辑中出现不必要的类型错误。

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