egg-joi

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-joi.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-joi
[travis-image]: https://img.shields.io/travis/eggjs/egg-joi.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-joi
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-joi.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-joi?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-joi.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-joi
[snyk-image]: https://snyk.io/test/npm/egg-joi/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-joi
[download-image]: https://img.shields.io/npm/dm/egg-joi.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-joi

Install

``bash
$ npm i egg-joi --save
`

Usage

`js
// {app_root}/config/plugin.js
exports.joi = {
enable: true,
package: 'egg-joi',
};
`

Configuration

`js
// {app_root}/config/config.default.js
exports.joi = {
options: {},
locale: {
'zh-cn': {}
},
throw: true, // throw immediately when capture exception
throwHandle: (error) => { return error; }, // error message format when throw is true
errorHandle: (error) => { return error; }, // error message format when throw is false
resultHandle: (result) => { return result; } // fromat result
};
`

see config/config.default.js for more detail.

Example

app/validator/sessions

`js
'use strict';

module.exports = app => {
const Joi = app.Joi;
return {
login: Joi.object().keys({
email: Joi.string().email(),
password: Joi.string().regex(/^[a-zA-Z0-9]{3,30}$/)
})
}
};
`

app/controller/sessions

`js
'use strict';

module.exports = app => {
class SessionsController extends app.Controller {
* login() {
this.ctx.validate(app.validator.sessions.login);
// this.ctx.validate(app.validator.sessions.login, this.ctx.request.body);
// this.ctx.validate(app.validator.sessions.login, this.ctx.request.body, {abortEarly: false}); see [joi] https://github.com/hapijs/joi/blob/v11.0.1/API.md
// let {error, value} = this.ctx.validate(app.validator.sessions.login, false);
// let {error, value} = this.ctx.validate(app.validator.sessions.login, this.ctx.request.body, false);
// let {error, value} = this.ctx.validate(app.validator.sessions.login, this.ctx.request.body, {abortEarly: false}, false);

this.body = 'hello';
}
}
return SessionsController;
};
``

Questions & Suggestions

Please open an issue here.

License

MIT