docs

Altheia Documentation

Online version: 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 aims at being very lightweight, simple to use and allow checking anything from a standard schema to very custom ones.

The goal of this library is to validate json -- for example in express middleware -- and complex 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

npm install altheia-async-data-validator

yarn add altheia-async-data-validator

Use

One simple step, import the library

import alt from 'altheia-async-data-validator';
// or
const alt = require('altheia-async-data-validator').default;

Typescript definitions are builtin the library, no need to install another package.

Core Concepts

• 👯‍ Creating instance
• ⚡️ Using Async
• 💪🏻 Custom Check
• 🗯 Language and translation
• 🎨 Reusing validation with Template
• 👾 Code your own Plugin

API

To see all validators and main api => API

Validators:

• Global
• Any
• String
• Object
• Date
• Number
• Array,
• Boolean
• Internet
• Function

Contribute

See Contributing