# Veni

Painless validation for TypeScript 🧘‍♀️🧘‍♂️

[![Build Status](https://travis-ci.org/BetterCallSky/veni.svg?branch=master)](https://travis-ci.org/BetterCallSky/veni) [![npm module](https://badge.fury.io/js/veni.svg)](https://www.npmjs.org/package/veni)

## Installation

```bash
npm i veni
yarn add veni
```

## Usage

```typescript
import { V, validate } from 'veni';

enum Gender {
  Male = 'Male',
  Female = 'Female',
  gender: V.enum().values<Gender>(Object.values(Gender)),
}

const schema = V.object().keys({
  username: V.string()
    .min(3)
    .max(30),
  firstName: V.string().optional(),
  lastName: V.string().optional(),
  password: V.string().regex(/^[a-zA-Z0-9]{3,30}$/),
  birthyear: V.number()
    .integer()
    .min(1900)
    .max(2013),
});

const data = {
  username: 'john',
  password: 'password',
  birthyear: '2000',
  email: 'john@example.com',
  gender: 'male'
};

const user = validate(data, schema, 'user');
```

‼️ Properties are inferred automatically.

![alt autocomplete](.gitbook/assets/autocomplete.gif)

## API Reference

Check API reference [here](https://veni.gitbook.io)

## Features

* Written and compatible with TypeScript in 100%.
* API is highly inspired on [joi](https://github.com/hapijs/joi), but simplified.
* Types are automatically inferred based on schema. Solves "double annotation" problem.
* No dependencies.
* Minimal bundle size.
* Very easy to extend, and add custom validation rules. Check [here](custom-validation-rules.md).

MIT