针对模型类型的部分结构进行操作

当使用 Prisma Client 时，你的 Prisma 模式中的每个模型都会被转换为一个专用的 TypeScript 类型。例如，假设你有以下 User 和 Post 模型

model User {
  id    Int     @id
  email String  @unique
  name  String?
  posts Post[]
}

model Post {
  id        Int     @id
  author    User    @relation(fields: [userId], references: [id])
  title     String
  published Boolean @default(false)
  userId    Int
}

从该模式生成的 Prisma Client 代码包含 User 类型的此表示形式

export declare type User = {
  id: string
  email: string
  name: string | null
}

问题：使用生成的模型类型的变体

描述

在某些情况下，你可能需要生成的 User 类型的变体。例如，当你的函数期望一个包含 posts 关系的 User 模型实例时。或者当你需要一个类型来在你的应用程序代码中只传递 User 模型的 email 和 name 字段时。

解决方案

作为解决方案，你可以使用 Prisma Client 的辅助类型来自定义生成的模型类型。

User 类型仅包含模型的标量字段，但没有考虑任何关系。这是因为在 Prisma Client 查询中默认情况下不包含关系。

但是，有时拥有一个包含关系的可用类型（即，你从使用 include 的 API 调用获得的类型）会很有用。类似地，另一个有用的场景可能是拥有一个仅包含模型标量字段子集的可用类型（即，你从使用 select 的 API 调用获得的类型）。

实现此目标的一种方法是在应用程序代码中手动定义这些类型

// 1: Define a type that includes the relation to `Post`
type UserWithPosts = {
  id: string
  email: string
  name: string | null
  posts: Post[]
}

// 2: Define a type that only contains a subset of the scalar fields
type UserPersonalData = {
  email: string
  name: string | null
}

虽然这当然可行，但这种方法会增加 Prisma 模式发生更改时的维护负担，因为你需要手动维护类型。对此的一个更简洁的解决方案是使用 Prisma Client 在 Prisma 命名空间下生成并公开的 UserGetPayload 类型，并结合使用 validator。

以下示例使用 Prisma.validator 创建两个类型安全的对象，然后使用 Prisma.UserGetPayload 实用程序函数创建一个可用于返回所有用户及其帖子的类型。

import { Prisma } from '@prisma/client'

// 1: Define a type that includes the relation to `Post`
const userWithPosts = Prisma.validator<Prisma.UserDefaultArgs>()({
  include: { posts: true },
})

// 2: Define a type that only contains a subset of the scalar fields
const userPersonalData = Prisma.validator<Prisma.UserDefaultArgs>()({
  select: { email: true, name: true },
})

// 3: This type will include a user and all their posts
type UserWithPosts = Prisma.UserGetPayload<typeof userWithPosts>

后一种方法的主要优势在于

更简洁的方法，因为它利用了 Prisma Client 生成的类型
在模式更改时降低维护负担并提高类型安全性

问题：获取函数的返回类型

描述

在对模型执行 select 或 include 操作并从函数返回这些变体时，获取返回类型可能会很困难，例如

// Function definition that returns a partial structure
async function getUsersWithPosts() {
  const users = await prisma.user.findMany({ include: { posts: true } })
  return users
}

从上面的代码片段中提取表示“带有帖子的用户”的类型需要一些高级的 TypeScript 用法

// Function definition that returns a partial structure
async function getUsersWithPosts() {
  const users = await prisma.user.findMany({ include: { posts: true } })
  return users
}

// Extract `UsersWithPosts` type with
type ThenArg<T> = T extends PromiseLike<infer U> ? U : T
type UsersWithPosts = ThenArg<ReturnType<typeof getUsersWithPosts>>

// run inside `async` function
const usersWithPosts: UsersWithPosts = await getUsersWithPosts()

解决方案

使用 Prisma 命名空间公开的 PromiseReturnType，你可以更优雅地解决此问题

import { Prisma } from '@prisma/client'

type UsersWithPosts = Prisma.PromiseReturnType<typeof getUsersWithPosts>

问题：使用生成的模型类型的变体​

描述​

解决方案​

问题：获取函数的返回类型​

描述​

解决方案​

问题：使用生成的模型类型的变体

描述

解决方案

问题：获取函数的返回类型

描述

解决方案