joi-assert

Assert values using Joi schemas

Use Spumko's Joi in assertion statements that validate and sanitize values.

Assertions throw an AssertionError with a compact, readable message if validation fails. This makes Joi schemas usable in assertions for use with frameworks like mocha.

If validation succeeds the sanitized value returned, via Joi's support for default values and unknown property stripping etc. This makes Joi schemas usable as input-assertions in the methods of user facing methods of your modules and APIs.

:warning: Early phase so users beware.

Usage

Get it from npm:

$ npm install joi
$ npm install joi-assert

Basic assertion

// import plain Joi
var Joi = require('joi');

// import the module
var joiAssert = require('joi-assert');

// get a Joi schema
var schema = Joi.string().min(5);

// validate data and throw AssertionError on failure
joiAssert(raw, schema);

// assertion returns valid data as oneliner
var valid = joiAssert(raw, schema);

Error message

// add schema description to error message
var schema = Joi.string().min(5).description('lower bound');

// additonal message per call
input = joiAssert(imput, schema, 'input check');

Validate and sanitize input

// get a schema using default(), .stripUnknown etc
var schema = Joi.object({
	foo: Joi.string().required(),
	bar: Joi.string().optional().default('hoge')
}).object({
	stripUnknown: true
});

// get valid but dirty input data
var raw = {
	foo: 'abc',
	nope: null
}
// pass through assertion
var data = joiAssert(raw, schema);

// data is now clean
{
	foo: 'abc',
	bar: 'hoge'
}

Bake assertion function

// get a schema
var schema = Joi.string().min(5).max(10);

// get assertion closure
var fiveTen = joiAssert.bake(schema, 'five to ten');

// nice
fiveTen(10);
fiveTen(5);

// clean
input = fiveTen(input);

// kablam!
fiveTen(20);

// get fancy
var clean = [5, 6, 7, 8].map(fiveTen);

Todo

Improve vars argument
- Support argument as Object, Array and String
- Consider sprintf style smart args (order etc)
- Test it
Add options to customise error message:
- Amount of concatenated reports
- Multiline message

Build

Install development dependencies:

$ npm install
$ npm install -g grunt-cli

Build and run tests using grunt:

$ grunt test

See the Gruntfile.js for additional commands.

Contributions

Pull requests with fixes are very welcome, for new features best ask via a issue first.

License

Licensed under the MIT license.

Current Tags

0.0.3 ... latest (11 years ago)

2 Versions

0.0.3 ... 11 years ago
0.0.2 ... 11 years ago