# vadilate

> Validate an object against an OpenAPI schema.

Latest version **2.1.0** (published 2021-05-07) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install vadilate
pnpm add vadilate
yarn add vadilate
bun add vadilate
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2021-05-07 |
| First published | 2021-04-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 64.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Eric MORAND |
| Maintainers | ericmorand |
| Keywords | validation, validate, schema, openapi, swagger |

## Links

- npm: https://www.npmjs.com/package/vadilate
- Repository: https://gitlab.com/nightlycommit/vadilate
- Homepage: https://gitlab.com/nightlycommit/vadilate#readme
- Issues: https://gitlab.com/nightlycommit/vadilate/-/issues
- npm.io page: https://npm.io/package/vadilate

## Alternatives

- [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads
- [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads
- [@lokalise/projects-engine-contracts](https://npm.io/package/@lokalise/projects-engine-contracts.md) — 978 weekly downloads
- [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads
- [@oridune/validator](https://npm.io/package/@oridune/validator.md) — 16 weekly downloads

## Recent versions

- 2.1.0 (latest) — 2021-05-07
- 2.0.0 — 2021-05-06
- 1.0.0 — 2021-04-28
- 0.1.0 — 2021-04-28

## README

# Vadilate

```
Error: must be 'Validate'

░░░░░▄▄▄▄▀▀▀▀▀▀▀▀▄▄▄▄▄▄░░░░░░░
░░░░░█░░░░▒▒▒▒▒▒▒▒▒▒▒▒░░▀▀▄░░░░
░░░░█░░░▒▒▒▒▒▒░░░░░░░░▒▒▒░░█░░░
░░░█░░░░░░▄██▀▄▄░░░░░▄▄▄░░░░█░░
░▄▀▒▄▄▄▒░█▀▀▀▀▄▄█░░░██▄▄█░░░░█░
█░▒█▒▄░▀▄▄▄▀░░░░░░░░█░░░▒▒▒▒▒░█
█░▒█░█▀▄▄░░░░░█▀░░░░▀▄░░▄▀▀▀▄▒█
░█░▀▄░█▄░█▀▄▄░▀░▀▀░▄▄▀░░░░█░░█░
░░█░░░▀▄▀█▄▄░█▀▀▀▄▄▄▄▀▀█▀██░█░░
░░░█░░░░██░░▀█▄▄▄█▄▄█▄████░█░░░
░░░░█░░░░▀▀▄░█░░░█░█▀██████░█░░
░░░░░▀▄░░░░░▀▀▄▄▄█▄█▄█▄█▄▀░░█░░
░░░░░░░▀▄▄░▒▒▒▒░░░░░░░░░░▒░░░█░
░░░░░░░░░░▀▀▄▄░▒▒▒▒▒▒▒▒▒▒░░░░█░
░░░░░░░░░░░░░░▀▄▄▄▄▄▄▄▄▄▄▄▄▄█░░
```

Validate an object against an OpenAPI schema.

[![NPM version][npm-image]][npm-url] [![Coverage percentage][coveralls-image]][coveralls-url]

## Usage

```ts
import {createSchema} from 'vadilate'
import {strictEqual} from "assert";

const schema = createSchema({
    type: "string",
    enum: ['Validate']
});

const errors = schema.validate("Vadilate");

strictEqual(errors[0].message, "must be 'Validate'");
```

> More to come...

## API

Read the [documentation](https://nightlycommit.gitlab.io/vadilate/) for more information.

## Contributing

-   Fork the main repository
-   Code
-   Implement tests using [tape](https://www.npmjs.com/package/tape)
-   Issue a pull request keeping in mind that all pull requests must reference an issue in the issue queue

## License

Apache-2.0 © [Eric MORAND](<>)

[npm-image]: https://badge.fury.io/js/vadilate.svg
[npm-url]: https://npmjs.org/package/vadilate
[coveralls-image]: https://coveralls.io/repos/gitlab/nightlycommit/vadilate/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/gitlab/nightlycommit/vadilate

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