diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown index 2e3c0de3ca..be476ce2fd 100644 --- a/doc/api/assert.markdown +++ b/doc/api/assert.markdown @@ -1,41 +1,41 @@ -## Assert +# Assert This module is used for writing unit tests for your applications, you can access it with `require('assert')`. -### assert.fail(actual, expected, message, operator) +## assert.fail(actual, expected, message, operator) Throws an exception that displays the values for `actual` and `expected` separated by the provided operator. -### assert(value, message), assert.ok(value, [message]) +## assert(value, message), assert.ok(value, [message]) Tests if value is a `true` value, it is equivalent to `assert.equal(true, value, message);` -### assert.equal(actual, expected, [message]) +## assert.equal(actual, expected, [message]) Tests shallow, coercive equality with the equal comparison operator ( `==` ). -### assert.notEqual(actual, expected, [message]) +## assert.notEqual(actual, expected, [message]) Tests shallow, coercive non-equality with the not equal comparison operator ( `!=` ). -### assert.deepEqual(actual, expected, [message]) +## assert.deepEqual(actual, expected, [message]) Tests for deep equality. -### assert.notDeepEqual(actual, expected, [message]) +## assert.notDeepEqual(actual, expected, [message]) Tests for any deep inequality. -### assert.strictEqual(actual, expected, [message]) +## assert.strictEqual(actual, expected, [message]) Tests strict equality, as determined by the strict equality operator ( `===` ) -### assert.notStrictEqual(actual, expected, [message]) +## assert.notStrictEqual(actual, expected, [message]) Tests strict non-equality, as determined by the strict not equal operator ( `!==` ) -### assert.throws(block, [error], [message]) +## assert.throws(block, [error], [message]) Expects `block` to throw an error. `error` can be constructor, regexp or validation function. @@ -72,11 +72,11 @@ Custom error validation: "unexpected error" ); -### assert.doesNotThrow(block, [error], [message]) +## assert.doesNotThrow(block, [error], [message]) Expects `block` not to throw an error, see assert.throws for details. -### assert.ifError(value) +## assert.ifError(value) Tests if value is not a false value, throws if it is a true value. Useful when testing the first argument, `error` in callbacks.