chai-nodules-helpers
v2.0.2
Published
nodules-specific assertion helpers for chai
Downloads
18
Readme
Nodules-specific assertions for Chai
Installation and usage
$ npm install chai-nodules-helpers
var assert = require('chai').use(require('chai-nodules-helpers')).assert;
assert.throwTerror(...);
assert.mixedProperly(...);
Note
All assertions available for assert style only.
Objex
assert.isMixed()
assert.isMixed(Target, Mixin, mixinName, staticExceptions, prototypeExceptions, mixingArgs)
{Objex} Target
– constructor;{Function|Object} Mixin
– mixin;{String} mixinName
– used in assertions messages;{String[]} staticExceptions
– array of statics propertyies names excluded from assertions;{String[]} prototypeExceptions
– array of prototypes propertyies names excluded from assertions;{Array} [mixingArgs]
– additional arguments to pass tomixin()
afterMixin
itself.
assert.canBeMixed()
assert.canBeMixed(Target, Mixin, mixinName, staticExceptions, prototypeExceptions, mixingArgs)
{Objex} Target
– constructor, inheritor of the Objex,mixin
method applies to;{Function|Object} Mixin
– mixin;{String} mixinName
– used in assertions messages;{String[]} staticExceptions
– array of statics propertyies names excluded from assertions;{String[]} prototypeExceptions
– array of prototypes propertyies names excluded from assertions;{Array} [mixingArgs]
– additional arguments to pass tomixin()
afterMixin
itself.
Terror
assert.throwTerror()
assert.throwTerror(fn, ErrorClass, spec)
{Function} fn
– a function which expected to throw;{Fucntion|Error|Terror} [ErrorClass]
– must be a Terror inheritor, ifspec
is specified, or any Error inheritor in other case;{RegExp|String|Number} [spec]
– error specifier; can be a string (Terror code name), number (Terror code) or RegExp (used for message test).
If second argument is not a constructor (function), then helper recognize it as an specifier arg spec
.