zod-fetch 中文文档教程

Question

Zod Fetch

zod-fetch 是一个简单的 API，用于使用 Zod 构建类型和运行时安全的获取器函数模式。

用法

使用默认的 fetcher

您可以使用 createZodFetcher 创建一个 fetcher：

import { z } from "zod";
import { createZodFetcher } from "zod-fetcher";

const fetchWithZod = createZodFetcher();

fetchWithZod(
  // The schema you want to validate with
  z.object({
    hello: "world",
  }),
  // Any parameters you would usually pass to fetch
  "/my-api",
).then((res) => {
  console.log(res);
  //          ^? { hello: string }
});

如果您没有将 fetcher 传递给 createZodFetcher，它会使用一个合理的默认 fetcher（使用 fetch API）来抓取所需的数据。

使用自定义提取器

您可以将自定义提取器传递给 zod-fetcher：

import { z } from "zod";
import { createZodFetcher } from "zod-fetcher";
import axios from "axios";

const fetchWithZod = createZodFetcher(axios.get);

fetchWithZod(
  z.object({
    data: z.object({
      name: z.string(),
    }),
  }),
  "/user",
  {
    params: {
      id: 12345,
    },
  },
).then((res) => {
  console.log(res);
  //          ^? { data: { name: string } }
});

为什么会存在这个？

对于想要将运行时安全性与获取器（一种极其常见的用例）结合起来的团队，您通常有一个选择：

1. 使用大型、包罗万象的解决方案，例如 tRPC
2. 自行破解一些东西，

我希望这个小型 API 为希望弥合这一差距的团队提供了一个很好的折衷方案。或者，至少提供了一些漂亮的示例代码，您可以将其复制并粘贴到您的项目中。