zod README

The project's README from github.com/colinhacks/zod. As one markdown file: README.md.

packages/zod/README.md

zod (colinhacks/zod)

Searching Database…

44.1K ·GitHub
这是什么?Zod 是一个数据校验(schema 校验)库:你先描述数据应该长什么样,它会在运行时用这个描述去检查实际的数据是否符合。
它是接入我代码里的库,还是需要我自己运行的东西?它就是一个普通的代码库:把 zod 引入你的项目,在自己的代码里调用即可——没有什么需要运行的应用、服务器或界面。
怎么把它加到项目里?安装 zod 包(npm install zod),然后在代码里用 schema 描述你的数据就可以用了。
引入它会不会连带装一堆别的包?不会——仓库里没有列出任何运行时依赖,你现有的 TypeScript 或 JavaScript 环境就够了。
我是不是必须写 TypeScript 才用得上它?它是 TypeScript 优先的:schema 可以通过类型推断同时充当静态类型,在 TypeScript 项目里收益最大。
zod 是一个包还是好几个包?好几个——这个 monorepo 构建时会产出主包 zod,还有一个单独的 @zod/mini 包。
Creator
colinhacks
Size
26.4 MB
Stars
44.1K
Age
6y
Commits · 90 Days