@zeit/schemas

All schemas used for validation that are shared between our projects

Last updated 4 years ago by nwienert .

MIT · Repository · Bugs · Original npm · Tarball · package.json

$ cnpm install @zeit/schemas

SYNC missed versions from official npm registry.

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:

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

Next, set up AJV (the validator) and run the schema through it:

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.

Current Tags

2.26.0 ... latest (4 years ago)

49 Versions

Maintainers (202)

aaronbrown-vercel

adriancooney_vercel

chris-olszewski

daniel.campbell

edgarcerecerezv

endangeredmassa

fastandfearless

gbibeaulaviolette

hellojennifertran

housseindjirdeh

hungrybearstudio

janicklas-ralph

jasongullickson

sebastianroming

shaquilhansford

swarnavasengupta

vercel-release-bot

Downloads

Today 0

This Week 0

This Month 2

Last Day 0

Last Week 2

Last Month 0

Dependencies (0)

None

Dev Dependencies (5)

@zeit/best 0.4.3
@zeit/eslint-config-node 0.3.0
@zeit/git-hooks 0.1.4
ajv 6.5.1
eslint 4.19.1

Dependents (1)

serve

Copyright 2013 - present © cnpmjs.org | Home |