Installation

npm

npm install @adrocodes/pigeon zod

yarn

yarn add @adrocodes/pigeon zod

pnpm

pnpm add @adrocodes/pigeon zod

bun

bun add @adrocodes/pigeon zod

Why do I need to install zod?

Pigeon depends on zod for validation. At this point it does not support any other validation libraries.

Because zod is being used, TypeScript must be in strict mode. See all zod requirements here.

I want the source

All good, go to the Github page and copy the index.ts into a pigeon module directory. You’ll have your very own version of pigeon. You will still need to install zod and you’ll need to change any imports to @/modules/pigeon (change to match your project) instead of @adrocodes/pigeon.