如何为Prisma的Payment模型定义精细化返回类型？

问题场景 #

我在Prisma Schema中定义了如下Payment模型：

model Payment {
  id                      Int      @default(autoincrement()) @id
  covered                 Boolean?
  paid                    Boolean
  amount                  Float // 注：Prisma中无number类型，此处修正为Float，若需高精度数值可替换为Decimal
}

当调用prisma.payment.findMany()并选中所有字段时，TypeScript自动推导的类型为：

type Payment = {
  id: number;
  covered?: boolean;
  paid: boolean;
  amount: number;
}

但我需要更精准的类型约束：当paid为true时，covered必须是非空值；当paid为false时，covered字段不存在，即目标类型为：

type Payment = {
  id: number;
  amount: number;
} & (
  | { paid: false; covered?: never }
  | { paid: true; covered: boolean }
);

我尝试过用类型断言强制转换，但写法过于繁琐：

const payments = await prisma.payment.findMany(/* 查询参数 */) as Omit<typeof payments[number], 'paid' | 'covered'> & (
  | { paid: false; covered?: never }
  | { paid: true; covered: boolean }
);

有没有更优雅的实现方式？

解决方案 #

1. 自定义类型+复用断言 #

先预先定义好目标精细化类型，后续查询直接复用，简化断言逻辑：

// 定义全局复用的精细化类型
type RefinedPayment = {
  id: number;
  amount: number;
} & (
  | { paid: false; covered?: never }
  | { paid: true; covered: boolean }
);

// 查询时直接断言为自定义类型数组
const payments = await prisma.payment.findMany() as RefinedPayment[];

这种方式避免了重复编写冗长的类型交叉逻辑，适合需要在多个查询场景复用该类型的场景。

2. 拆分查询+Prisma自动推导 #

如果业务逻辑可以明确区分paid的状态，可拆分查询并结合select参数，让Prisma自动推导精准类型，无需断言：

// 查询已支付记录：强制返回covered字段，Prisma自动推导covered为非空
const paidPayments = await prisma.payment.findMany({
  where: { paid: true },
  select: {
    id: true,
    amount: true,
    paid: true,
    covered: true
  }
});
// 推导类型：Array<{ id: number; amount: number; paid: true; covered: boolean }>

// 查询未支付记录：排除covered字段，类型中自动无该字段
const unpaidPayments = await prisma.payment.findMany({
  where: { paid: false },
  select: {
    id: true,
    amount: true,
    paid: true
  }
});
// 推导类型：Array<{ id: number; amount: number; paid: false }>

该方案无需类型断言，类型安全性最高，适合能按paid状态拆分查询的业务场景。

3. 全局扩展Prisma Client类型 #

如果希望所有Payment相关查询都默认使用该精细化类型，可以通过类型声明文件全局覆盖Prisma生成的类型：

1. 创建prisma-extensions.d.ts文件
2. 写入以下代码：

import { Prisma } from '@prisma/client';

declare module '@prisma/client' {
  export type Payment = {
    id: number;
    amount: number;
  } & (
    | { paid: false; covered?: never }
    | { paid: true; covered: boolean }
  );
}

注意：此方案会全局替换Payment类型，需确保数据库中所有paid: true的记录都有非空的covered值，否则会出现类型与实际数据不匹配的风险。

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