@jackdbd/zod-schemas

Zod schemas

Some Zod schemas I reuse across projects.

Table of Contents

• Installation
• Development
• Docs

Installation

npm install @jackdbd/zod-schemas

Development

Launch both the TypeScript compiler and the Node.js test runner in watch mode:

npm run dev

Build all TypeScript files with the TypeScript compiler, and all docs with TypeDoc and api-extractor + api-documenter:

npm run build

You can also build the TypeScript files and the docs separately:

npm run build:ts
npm run docs

Whenever you change the public API of this project, you need to run api-extractor with the --local flag:

npx api-extractor run --config ./config/api-extractor.json --verbose --local

Docs

Preview the documentation generated by TypeDoc:

npm run serve:docs

Note: it doesn't make much sense to preview the API docs generated by api-extractor + api-documenter. They are just a bunch of markdown files.