assertthat

assertthat provides fluent TDD.

Installation

$ npm install assertthat

Quick Start

First you need to add a reference to assertthat to your application.

var assert = require('assertthat');

Now you are able to use the various constraints.

var add = function(first, second) {
  return first + second;
};

var actual = add(23, 42),
    expected = 65;

assert.that(actual).is.equalTo(expected);

Available constraints

Please note that any constraint can be negated using the not keyword.

atLeast

Asserts that actual is greater than or equal to expected.

assert.that(actual).is.atLeast(expected);
assert.that(actual).is.not.atLeast(expected);

atMost

Asserts that actual is less than or equal to expected.

assert.that(actual).is.atMost(expected);
assert.that(actual).is.not.atMost(expected);

between

Asserts that actual is between expectedLow and expectedHigh.

assert.that(actual).is.between(expectedLow, expectedHigh);
assert.that(actual).is.not.between(expectedLow, expectedHigh);

containing

Asserts that actual contains expected.

assert.that(actual).is.containing(expected);
assert.that(actual).is.not.containing(expected);

endingWith

Asserts that actual ends with expected.

assert.that(actual).is.endingWith(expected);
assert.that(actual).is.not.endingWith(expected);

equalTo

Asserts that actual is equal to expected.

assert.that(actual).is.equalTo(expected);
assert.that(actual).is.not.equalTo(expected);

false

Asserts that actual is false.

assert.that(actual).is.false();
assert.that(actual).is.not.false();

falsy

Asserts that actual is falsy.

assert.that(actual).is.falsy();
assert.that(actual).is.not.falsy();

greaterThan

Asserts that actual is greater than expected.

assert.that(actual).is.greaterThan(expected);
assert.that(actual).is.not.greaterThan(expected);

instanceOf

Asserts that actual is an instance of expected.

assert.that(actual).is.instanceOf(expected);
assert.that(actual).is.not.instanceOf(expected);

lessThan

Asserts that actual is less than expected.

assert.that(actual).is.lessThan(expected);
assert.that(actual).is.not.lessThan(expected);

NaN

Asserts that actual is NaN.

assert.that(actual).is.NaN();
assert.that(actual).is.not.NaN();

null

Asserts that actual is null.

assert.that(actual).is.null();
assert.that(actual).is.not.null();

ofType

Asserts that actual is of type expected.

assert.that(actual).is.ofType(expected);
assert.that(actual).is.not.ofType(expected);

sameAs

Asserts that actual is identical to expected.

assert.that(actual).is.sameAs(expected);
assert.that(actual).is.not.sameAs(expected);

startingWith

Asserts that actual starts with expected.

assert.that(actual).is.startingWith(expected);
assert.that(actual).is.not.startingWith(expected);

throwing

Asserts that f throws an exception.

assert.that(f).is.throwing();
assert.that(f).is.not.throwing();

Alternatively, asserts that f throws an exception with the expected message. For the expected message you can either specify a string or a regular expression.

assert.that(f).is.throwing(expected);
assert.that(f).is.not.throwing(expected);

true

Asserts that actual is true.

assert.that(actual).is.true();
assert.that(actual).is.not.true();

undefined

Asserts that actual is undefined.

assert.that(actual).is.undefined();
assert.that(actual).is.not.undefined();

existing

Assert that actual exists

assert.that(actual).is.existing();
assert.that(actual).is.not.existing();

array

Assert that actual is an array

assert.that(actual).is.array();

Running the build

This module can be built using Grunt. Besides running the tests, this also analyses the code. To run Grunt, go to the folder where you have installed assertthat and run grunt. You need to have grunt-cli installed.

$ grunt

License

The MIT License (MIT) Copyright (c) 2011-2015 the native web.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.