zod README

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

packages/zod/README.md

zod (colinhacks/zod)

validation
Searching Database…

44.2K ·GitHub
What is this?Zod is a schema validation library: you describe what your data should look like, and it checks real values against that description at runtime.
Is it a library I wire into my code, or something I run?It is a plain code library: you import zod into your project and call it from your own code — there is no app, server, or UI to run.
How do I add it to a project?Install the zod package (npm install zod) and start describing your data with schemas in code.
Will pulling it in drag other packages along?No — the repository lists no runtime dependencies, so your existing TypeScript or JavaScript setup is enough.
Do I have to be writing TypeScript for it to make sense?It is TypeScript-first: schemas double as static types through inference, which pays off most in TypeScript codebases.
Is zod one package or several?Several — the monorepo build produces the main zod package together with a separate @zod/mini package.
Creator
colinhacks
Size
26.4 MB
Stars
44.2K
Age
6y
Commits · 90 Days