https://github.com/bodinsamuel/altheia

A very simple, fast and customizable async data validator
https://github.com/bodinsamuel/altheia

async async-validation schema typescript validate validation validator

Last synced: 2 months ago
JSON representation

A very simple, fast and customizable async data validator

• Host: GitHub
• URL: https://github.com/bodinsamuel/altheia
• Owner: bodinsamuel
• License: mit
• Created: 2018-01-30T16:50:32.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2023-10-17T07:07:26.000Z (about 1 year ago)
• Last Synced: 2024-10-14T06:30:01.355Z (3 months ago)
• Topics: async, async-validation, schema, typescript, validate, validation, validator
• Language: TypeScript
• Homepage: https://bodinsamuel.github.io/altheia/
• Size: 6.22 MB
• Stars: 10
• Watchers: 2
• Forks: 3
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Altheia

[![CI](https://github.com/bodinsamuel/altheia/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/bodinsamuel/altheia/actions/workflows/ci.yml)

A very simple, fast and customizable async data validator, inspired by Joi .

```javascript

await alt

  .string()

  .email()

  .custom('not_in_db', async (val) => await searchDB(val));

```

Online documentation: [github.io/altheia/](https://bodinsamuel.github.io/altheia/)

## 🤓 Why?

After searching for a long time a simple data validator that allow async validation, I decided to implement one. Heavily inspired from Joi, it aim at being very lightweight, simple to use and allow to check anything from standard schema to very custom ones.

The goal of this library is to validate json -- for example in express middleware -- and complexe javascript object.

- 💅 **Easy to customize.** Use builtin or create your own validation.

- ⚡️**Async.** Call any resources asynchronously to do check your data (e.g: database, xhr...)

- 🤩 **Typescript.** No more checking long documentation and wondering what to write.

- 🧘 **Easy to use.** No configuration required

## ✨ Install

```bash

npm install altheia-async-data-validator

```

```sh

yarn add altheia-async-data-validator

```

## 🖼 Example

```javascript

import alt from 'altheia-async-data-validator'

alt.lang('string.min', (name, args) => `This ${name} is too short`);

alt.template('login', alt.string().min(3).not('admin'));

const errors = await alt({

    login: alt.is('login'),

    email: alt.string()

        .email()

        .custom('not_in_db', async (val) => await searchDB(val)),

    eyes: alt.number().integer().positive().max(2),

    date: alt.date().iso(),

    gender: alt.string().if({

        test: test => test.uppercase(),

        then: test => test.in('F', 'M'),

        otherwise: test => test.in('female', 'male')

    })

}).options({

    required: true

}).validate({

    login: 'leela',

    email: '[email protected]',

    eyes: 1,

    date: '2015-01-04T17:35:22Z',

    gender: 'female',

});

console.log(errors); // false

```

## 📚 Documentation

- Full [Documentation](/docs/)

- Validator [API](/docs/api.md)

- [Changelog](../master/CHANGELOG.md)

## 📋 Contributing

Every contribution or feature requests will be gladly accepted in the issue section.