# sengi-validation

> A validation library for doc types and role types being used with the Sengi document-database system.

Latest version **1.8.1** (published 2020-10-20) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install sengi-validation
pnpm add sengi-validation
yarn add sengi-validation
bun add sengi-validation
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.8.1 |
| Published | 2020-10-20 |
| First published | 2020-09-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 109.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Karl Hulme |
| Maintainers | karlhulme |

## Links

- npm: https://www.npmjs.com/package/sengi-validation
- Repository: https://github.com/karlhulme/sengi-validation
- Homepage: https://github.com/karlhulme/sengi-validation#readme
- Issues: https://github.com/karlhulme/sengi-validation/issues
- npm.io page: https://npm.io/package/sengi-validation

## Dependencies (5)

- [jsonotron](https://npm.io/package/jsonotron.md) ^10.2.0
- [clone-deep](https://npm.io/package/clone-deep.md) ^4.0.1
- [check-types](https://npm.io/package/check-types.md) ^11.1.2
- [jsonotron-core-field-types](https://npm.io/package/jsonotron-core-field-types.md) ^7.4.3
- [jsonotron-core-format-validators](https://npm.io/package/jsonotron-core-format-validators.md) ^3.0.0

## Recent versions

- 1.8.1 (latest) — 2020-10-20
- 1.8.0 — 2020-09-15
- 1.7.0 — 2020-09-13
- 1.6.1 — 2020-09-07
- 1.6.0 — 2020-09-07
- 1.5.0 — 2020-09-07
- 1.4.0 — 2020-09-07
- 1.3.0 — 2020-09-07
- 1.2.0 — 2020-09-07
- 1.1.1 — 2020-09-06
- 1.1.0 — 2020-09-06
- 1.0.0 — 2020-09-06

## README

# Sengi-Validation

![](https://github.com/karlhulme/sengi-validation/workflows/CD/badge.svg)
[![npm](https://img.shields.io/npm/v/sengi-validation.svg)](https://www.npmjs.com/package/sengi-validation)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

This library provides validation functions for the (Sengi)[https://github.com/karlhulme/sengi] document-database system.

It provides functions for checking that a given document adheres to it's document type.  It also validates the other resources: enum types, schema types, format validators and role types.

This library can be used to to verify doc types independently of the engine, including as part of a set of automated tests.

## Installation

```bash
npm install sengi-validation
```

## Development

Code base adheres to the rules chosen by https://standardjs.com/.  Code is formatted with 2 spaces.

Tests are written using Jest with 100% coverage.

```javascript
npm test
```

## Continuous Deployment

Any pushes or pull-requests on non-master branches will trigger the test runner.

Any pushes to master will cause the library to be re-published.

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