Zod Plugin for Express Zod API
Overview
This module extends Zod functionality when it's imported:
- Adds
.example() method to all Zod schemas:
- shorthand for
.meta({ examples: [...] });
- Adds
.deprecated() method to all Zod schemas:
- shorthand for
.meta({ deprecated: true });
- Adds
.xBrand() method to all Zod schemas:
- shorthand for
.meta({ "x-brand": ... }) making the brand available in runtime;
- This method does not conflict with Zod 4.4+ internal mechanisms;
- Adds
.label() method to ZodDefault:
- shorthand for
.meta({ default: ... });
- Adds
.remap() method to ZodObject for renaming object properties:
- Supports a mapping object or an object transforming function as an argument;
- Relies on
R.renameKeys() from the ramda library;
Requirements
- Compatible with Zod versions
^4.5.4;
Basic usage
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-plugin 是什么？
Zod plugin for express-zod-api
如何安装 @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 和提交记录判断。