# @express-zod-api/zod-plugin 中文文档

规范地址：https://npmcn.com/package/%40express-zod-api/zod-plugin/

版本：7\.0\.0
npm 元数据更新时间：2026-11-01T06:37:06.415Z
中文译文更新时间：2026-11-14T05:37:31.228Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40express-zod-api/zod-plugin
原文对照：https://npmcn.com/package/%40express-zod-api/zod-plugin/?lang=original
源码仓库：https://github.com/RobinTail/express-zod-api

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：10.3 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^22\.19\.0 \|\| ^24\.11\.0 \|\| ^26\.0\.0
- 运行依赖：1 个
- peer 依赖：zod ^4\.5\.4
- 首次发布：2025-08-06T17:19:41.803Z
- 最新版本发布：2026-11-01T06:37:05.959Z
- 近 30 天下载量：161481（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：31（近 12 个月 21 个）

## 中文简介

Express-zod- api 的 Zod 插件

## 安装

```sh
npm install @express-zod-api/zod-plugin
```

也可以使用：`pnpm add @express-zod-api/zod-plugin`、`yarn add @express-zod-api/zod-plugin`、`bun add @express-zod-api/zod-plugin`

## README

# 快速 Zod API 的 Zod 插件

## 概览

此模块在导入时扩展了 Zod 功能 :

-   添加数 `.example()` 所有 Zod 计划的方法:
    -   缩写 `.meta({ examples: [...] })`· ;
-   添加数 `.deprecated()` 所有 Zod 计划的方法:
    -   缩写 `.meta({ deprecated: true })`· ;
-   添加数 `.xBrand()` 所有 Zod 计划的方法:
    -   缩写 `.meta({ "x-brand": ... })` 在运行时间提供品牌;
    -   这种方法与Zod 4.4+内部机制不相冲突;
-   添加数 `.label()` 方法 `ZodDefault`数字 :
    -   缩写 `.meta({ default: ... })`· ;
-   添加数 `.remap()` 方法 `ZodObject` 用于重命名对象属性 :
    -   支持将映射对象或对象转换函数作为参数;
    -   继续使用 `R.renameKeys()` 从 `ramda` 图书馆;

## 所需资源

-   与 Zod 版本兼容 `^4.5.4`· ;

## 基本用途

```ts
import { z } from "zod";
import "@express-zod-api/zod-plugin";

const schema = z.string().example("test").example("another").xBrand("custom");

schema.meta(); // { examples: ["test", "another"], "x-brand": "custom" }
```

## 常见问题

### @express-zod-api/zod-plugin 是什么？

Express-zod- api 的 Zod 插件

### 如何安装 @express-zod-api/zod-plugin？

在项目目录运行 npm install @express-zod-api/zod-plugin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.5\.4）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @express-zod-api/zod-plugin 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @express-zod-api/zod-plugin 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @express-zod-api/zod-plugin 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.19\.0 \|\| ^24\.11\.0 \|\| ^26\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @express-zod-api/zod-plugin 可以商用吗？

@express-zod-api/zod-plugin 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @express-zod-api/zod-plugin 的下载量有多少？

根据 npm 官方下载统计，@express-zod-api/zod-plugin 在 2026/10/14 – 2026/11/12 这 30 天内被下载 161,481 次，日均约 5,383 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @express-zod-api/zod-plugin 还在维护吗？

最新版本 7\.0\.0 发布于 2026/11/01（12 天前）；至今共发布 31 个版本，其中过去 12 个月发布了 21 个；首次发布于 2025/08/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。