enjoi

enjoi

Converts a JSON schema to a Joi schema for object validation.

Schema Support

enjoi is built against json-schema v4, but does not support all of json-schema (yet).

Here is a list of some missing keyword support still being worked on:

• allOf
• anyOf
• oneOf
• not
• format
• object:patternProperties
• object:additionalProperties
• object:maxProperties
• object:minProperties
• array:items (supports as single schema, not supported as array of schemas).
• array:additionalItems

API

• enjoi(schema [, subSchemas])
  • schema - a JSON schema.
  • subSchemas - an (optional) object with keys representing schema ids, and values representing schemas.

Example:

var Joi = require('joi'),
    enjoi = require('enjoi');

var schema = enjoi({
    'title': 'Example Schema',
    'type': 'object',
    'properties': {
        'firstName': {
            'type': 'string'
        },
        'lastName': {
            'type': 'string'
        },
        'age': {
            'description': 'Age in years',
            'type': 'integer',
            'minimum': 0
        }
    },
    'required': ['firstName', 'lastName']
});

Joi.validate({firstName: 'John', lastName: 'Doe', age: 45}, schema, function (error, value) {
    error && console.log(error);
});

Can also call validate directly on the created schema.

schema.validate({firstName: 'John', lastName: 'Doe', age: 45}, function (error, value) {
    error && console.log(error);
});

Sub Schemas

Example:

var schema = enjoi({
    'title': 'Example Schema',
    'type': 'object',
    'properties': {
        'A': {
            '$ref': 'sub#/something'
        }
    }
}, {
    'sub': {
        'something': {
            'type': 'string'
        }
    }
});

Performance

Joi's validation is very fast. enjoi is meant to be used to prepare a schema in advance of validation; not alongside validation.

You can run a benchmark against tv4 by running the following command.

$ npm run bench
$
$ tv4 vs joi benchmark:
$     tv4: 44122 operations/second. (0.0226644ms)
$     joi: 111245 operations/second. (0.0089892ms)