joi 0,0,3,11,0,13,5,6 travis-ci npm

Object schema validation

joi Logo

Object schema description language and validator for JavaScript objects.

npm version Build Status <!–

Remove those badges until they work properly on semver.

Dependencies Status DevDependencies Status

–> NSP Status Known Vulnerabilities

Join the chat at https://gitter.im/hapijs/joi

Lead Maintainer: Nicolas Morel

Introduction

Imagine you run facebook and you want visitors to sign up on the website with real names and not something like [email protected] in the first name field. How would you define the limitations of what can be inputted and validate it against the set rules?

This is joi, joi allows you to create blueprints or schemas for JavaScript objects (an object that stores information) to ensure validation of key information.

Example

const Joi = require('joi');

const schema = Joi.object().keys({
    username: Joi.string().alphanum().min(3).max(30).required(),
    password: Joi.string().regex(/^[a-zA-Z0-9]{3,30}$/),
    access_token: [Joi.string(), Joi.number()],
    birthyear: Joi.number().integer().min(1900).max(2013),
    email: Joi.string().email()
}).with('username', 'birthyear').without('password', 'access_token');

// Return result.
const result = Joi.validate({ username: 'abc', birthyear: 1994 }, schema);
// result.error === null -> valid

// You can also pass a callback which will be called synchronously with the validation result.
Joi.validate({ username: 'abc', birthyear: 1994 }, schema, function (err, value) { });  // err === null -> valid

The above schema defines the following constraints: * username * a required string * must contain only alphanumeric characters * at least 3 characters long but no more than 30 * must be accompanied by birthyear * password * an optional string * must satisfy the custom regex * cannot appear together with access_token * access_token * an optional, unconstrained string or number * birthyear * an integer between 1900 and 2013 * email * a valid email address string

Usage

Usage is a two steps process. First, a schema is constructed using the provided types and constraints:

const schema = {
    a: Joi.string()
};

Note that joi schema objects are immutable which means every additional rule added (e.g. .min(5)) will return a new schema object.

Then the value is validated against the schema:

const {error, value} = Joi.validate({ a: 'a string' }, schema);

// or

Joi.validate({ a: 'a string' }, schema, function (err, value) { });

If the input is valid, then the error will be null, otherwise it will be an Error object.

The schema can be a plain JavaScript object where every key is assigned a joi type, or it can be a joi type directly:

const schema = Joi.string().min(10);

If the schema is a joi type, the schema.validate(value, callback) can be called directly on the type. When passing a non-type schema object, the module converts it internally to an object() type equivalent to:

const schema = Joi.object().keys({
    a: Joi.string()
});

When validating a schema:

  • Values (or keys in case of objects) are optional by default.

    Joi.validate(undefined, Joi.string()); // validates fine
    

    To disallow this behavior, you can either set the schema as required(), or set presence to "required" when passing options:

    Joi.validate(undefined, Joi.string().required());
    // or
    Joi.validate(undefined, Joi.string(), /* options */ { presence: "required" });
    
  • Strings are utf-8 encoded by default.

  • Rules are defined in an additive fashion and evaluated in order after whitelist and blacklist checks.

API

See the API Reference.

Browsers

Joi doesn’t directly support browsers, but you could use joi-browser for an ES5 build of Joi that works in browsers, or as a source of inspiration for your own builds.

Related Repositories

joi

joi

Object schema validation ...

webpack-validator

webpack-validator

Validates your webpack config with Joi ...

joi-router

joi-router

Configurable, input and output validated routing for koa ...

enjoi

enjoi

Converts a JSON schema to a Joi schema. ...

relish

relish

Better error messages for Hapi.js Joi validation ...


Top Contributors

Marsup hueniverse geek thegoleffect danielb2 arb kitcambridge nlf petreboy14 cl-joshcole jaswilli DavidTPate iamdoron jmlue42 yjh0502 DanielBarnes johnbrett paulillo fluidsonic carsy briansorahan AdrieanKhisbe fampinheiro jagoda martinheidegger mgartner AdriVanHoudt galenandrew aymericbeaumet phated

Dependencies

package version
hoek 4.x.x
isemail 3.x.x
items 2.x.x
topo 2.x.x
dev hapitoc 1.x.x
lab 14.x.x

Releases

-   v9.0.4 zip tar
-   v9.0.3 zip tar
-   v9.0.2 zip tar
-   v9.0.1 zip tar
-   v9.0.0 zip tar
-   v9.0.0-9 zip tar
-   v9.0.0-8 zip tar
-   v9.0.0-7 zip tar
-   v9.0.0-6 zip tar
-   v9.0.0-5 zip tar
-   v9.0.0-4 zip tar
-   v9.0.0-3 zip tar
-   v9.0.0-2 zip tar
-   v9.0.0-1 zip tar
-   v9.0.0-0 zip tar
-   v8.4.2 zip tar
-   v8.4.1 zip tar
-   v8.4.0 zip tar
-   v8.3.0 zip tar
-   v8.2.1 zip tar
-   v8.2.0 zip tar
-   v8.1.1 zip tar
-   v8.1.0 zip tar
-   v8.0.5 zip tar
-   v8.0.4 zip tar
-   v8.0.3 zip tar
-   v8.0.2 zip tar
-   v8.0.1 zip tar
-   v8.0.0 zip tar
-   v7.3.0 zip tar