TypeORM 0.3 FindOneBy不识别Nullable联合类型TS2322报错如何解决

问题根因 #

TypeORM 0.3 版本的查询条件类型FindOptionsWhere默认仅将undefined识别为可空字段的合法空值入参，没有自动联动实体字段的nullable: true配置放开null的类型校验，因此无法直接匹配项目自定义的Nullable<T> = T | null类型。

不需要全量替换现有类型定义，按改造成本从低到高可选以下方案： #

方案1：全局扩展TypeORM类型声明（零业务代码改动，优先推荐） #

在项目的全局类型声明文件（通常是src/global.d.ts或src/typings/index.d.ts，需确保被tsconfig.json的include配置覆盖）中追加如下模块声明，将null加入查询条件的合法值类型：

import type { FindOperator } from "typeorm";

declare module "typeorm" {
  // 重写查询条件属性的类型定义，兼容null入参
  type FindOptionsWhereProperty<Property> = Property extends Promise<infer I>
    ? FindOptionsWhereProperty<NonNullable<I>> | null
    : Property extends Array<infer I>
    ? FindOptionsWhereProperty<NonNullable<I>> | FindOperator<I | null> | null
    : Property | FindOperator<Property | null> | null;
}

声明生效后，TS会自动合并自定义的类型规则，所有原有传入Nullable<T>的查询字段位置都会自动通过类型校验，不需要修改任何业务代码。 #

方案2：查询时显式使用IsNull()操作符（仅修改查询传参位置） #

如果不想调整全局类型规则，不需要全量替换类型定义，仅需在传参时对null值做显式转换即可，TypeORM会自动生成IS NULL的SQL查询逻辑，完全符合类型要求：

import { Equal, IsNull } from "typeorm";

const entityToUpdate: MenuRecord = await MenuRecord.findOneByOrFail({
  Image: existingImage ?? IsNull(),
  ID: mId,
  Owner: Equal(user)
});

该方案仅需调整查询构造的传参逻辑，不会影响原有Nullable<T>的定义和其他位置的使用。 #

方案3：调整全局Nullable类型定义（仅改1行类型代码） #

直接修改项目全局的Nullable<T>定义，将undefined纳入联合类型，即可自动兼容TypeORM的类型校验，不需要逐个修改业务代码中的类型标注：

// 原有定义是 type Nullable<T> = T | null;
// 调整为：
type Nullable<T> = T | null | undefined;

TypeORM 持久化数据时会自动将实体字段的undefined值转换为null写入数据库，不会影响原有存null的业务逻辑，也不会导致其他使用Nullable<T>的位置出现类型报错。

注意：不要直接将Nullable<T>替换为T | undefined，否则原有所有给字段赋值null的代码位置会出现新的类型错误。

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