chai-param-nn
v0.0.4
Published
Adds useful methods for using chai to validate function parameters
Downloads
376
Maintainers
Readme
This is a fork of the popular but abandoned npm package chai-param (https://github.com/theblacksmith/chai-param).
Import path has been fixed to support modern Node.js versions.
chai-param-nn
Use chai to validate your method's parameters
Quick start
Install it on your project
npm install chai-param-nn
Require and load it
var chai = require('chai'),
chaiParam = require('chai-param-nn'),
expect = chai.expect,
should = chai.should(),
param = chaiParam.param;
chai.use(chaiParam);
Happy method guarding :)
function register(user, pass) {
// using should
param(user, 'user', 'UsersCtl.register').should.not.be.empty;
// or using expect
expect(user).param('user', 'UsersCtl.register')
.to.have.length.above(5)
.and.below(16);
}
Config
chai-param-nn can be configured by setting the values in chaiParam.config
object properties. E.g:
var chaiParam = require('chai-param-nn');
chaiParam.config.improveMessages = true;
improveMessages
Type:
Boolean
Default:true
Controls whether or not chai-param-nn
should replace chai's messages by more descriptive ones. So, for example, instead of getting
UserCtl.register: expected 'asdf' to have a length above 5 but got 4
You'll get...
showCaller on error messages
Type:
Boolean
Default:true
This option is only available for node and requires improveMessages
to be true
.
chaiParam.config.showCaller = true;
disableColors
Type:
Boolean
Default:false
Disables message coloring. Boring, but useful for tests.