# @zeit/schemas

> All schemas used for validation that are shared between our projects

Latest version **2.38.0** (published 2025-01-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @zeit/schemas
pnpm add @zeit/schemas
yarn add @zeit/schemas
bun add @zeit/schemas
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.38.0 |
| Published | 2025-01-10 |
| First published | 2018-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 35 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 90 |
| Author | leo |
| Maintainers | matheuss, nick.tracey, vercel-release-bot, zeit-bot, matt.straka |

## Links

- npm: https://www.npmjs.com/package/@zeit/schemas
- Repository: https://github.com/zeit/schemas
- Homepage: https://github.com/zeit/schemas#readme
- Issues: https://github.com/zeit/schemas/issues
- npm.io page: https://npm.io/package/@zeit/schemas

## Recent versions

- 2.38.0 (latest) — 2025-01-10
- 2.37.0 — 2024-09-16
- 2.36.0 — 2024-04-25
- 2.35.0 — 2024-01-02
- 2.34.0 — 2023-12-20
- 2.33.0 — 2023-12-19
- 2.32.0 — 2023-08-25
- 2.31.0 — 2023-04-26
- 2.30.0 — 2023-04-20
- 2.29.0 — 2023-01-25
- 2.28.0 — 2022-09-21
- 2.27.0 — 2022-09-21
- 2.26.0 — 2022-08-02
- 2.25.0 — 2022-08-02
- 2.24.0 — 2022-07-12
- … 46 more at https://npm.io/package/@zeit/schemas/versions

## README

# Vercel Schemas

Schemas used across many Vercel packages to validating config files, requests to APIs, and more.

## Why?

- Keep schemas used across Vercel projects in sync
- We use `.js` instead of `.json` because parsing JSON takes longer

## Usage

To get started, pick one of the schemas in this repository and load it:

```js
const schema = require('@zeit/schemas/deployment/config');
```

Next, set up [AJV](https://github.com/epoberezkin/ajv) (the validator) and run the schema through it:

```js
const AJV = require('ajv');

const ajv = new AJV({ allErrors: true });
const isValid = ajv.validate(schema, <object-to-validate>);

if (!isValid) {
	console.error(`The following entries are wrong: ${JSON.stringify(ajv.errors)}`);
}
```

That is all! :tada:

## Contributing

We are currently not accepting external contributions for this repository.

---
_Source: https://npm.io/package/@zeit/schemas · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._