chai-param

チャイを使用して、メソッドのパラメータを検証します

クイックスタート

プロジェクトにインストールします

npm install chai-param

必要条件を指定してロードします

var chai = require('chai'),
    chaiParam = require('chai-param'),
    expect = chai.expect,
    should = chai.should(),
    param = chaiParam.param;

chai.use(chaiParam);

メソッドガードをらくらく実行できます

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);
}

構成

チャイ-paramはchaiParam.configオブジェクトプロパティの値を設定することで設定できます。例

var chaiParam = require('chai-param');

chaiParam.config.improveMessages = true;

improveMessages

タイプ: Boolean既定値: true

chai-paramがチャイのメッセージをより記述的なメッセージに置き換えるかどうかを制御します。たとえば、次のメッセージの代わりに...

UserCtl.register: expected 'asdf' to have a length above 5 but got 4

次のメッセージが表示されます...

Improved error message

エラーメッセージのshowCaller

タイプ: Boolean既定値: true

このオプションはノードでのみ利用できます。また、improveMessagesをtrueにする必要があります。

chaiParam.config.showCaller = true;

disableColors

タイプ: Boolean既定値: false

メッセージのカラーリングを無効にします。退屈ですが、テストには役立ちます。