diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown index b81037287b499b..a607b92ead197f 100644 --- a/doc/api/assert.markdown +++ b/doc/api/assert.markdown @@ -6,25 +6,11 @@ This module is used so that Node.js can test itself. It can be accessed with `require('assert')`. However, it is recommended that a userland assertion library be used instead. -## 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]) Tests if value is truthy. It is equivalent to `assert.equal(!!value, true, message)`. -## assert.equal(actual, expected[, message]) - -Tests shallow, coercive equality with the equal comparison operator ( `==` ). - -## assert.notEqual(actual, expected[, message]) - -Tests shallow, coercive inequality with the not equal comparison operator -( `!=` ). - ## assert.deepEqual(actual, expected[, message]) Tests for deep equality. Primitive values are compared with the equal @@ -39,27 +25,72 @@ non-enumerable: // WARNING: This does not throw an AssertionError! assert.deepEqual(Error('a'), Error('b')); +## assert.deepStrictEqual(actual, expected[, message]) + +Tests for deep equality. Primitive values are compared with the strict equality +operator ( `===` ). + +## assert.doesNotThrow(block[, error][, message]) + +Expects `block` not to throw an error. See [assert.throws()](#assert_assert_throws_block_error_message) for more details. + +If `block` throws an error and if it is of a different type from `error`, the +thrown error will get propagated back to the caller. The following call will +throw the `TypeError`, since we're not matching the error types in the +assertion. + + assert.doesNotThrow( + function() { + throw new TypeError("Wrong value"); + }, + SyntaxError + ); + +In case `error` matches with the error thrown by `block`, an `AssertionError` +is thrown instead. + + assert.doesNotThrow( + function() { + throw new TypeError("Wrong value"); + }, + TypeError + ); + +## assert.equal(actual, expected[, message]) + +Tests shallow, coercive equality with the equal comparison operator ( `==` ). + +## assert.fail(actual, expected, message, operator) + +Throws an exception that displays the values for `actual` and `expected` +separated by the provided operator. + +## assert.ifError(value) + +Throws `value` if `value` is truthy. This is useful when testing the `error` +argument in callbacks. + ## assert.notDeepEqual(actual, expected[, message]) Tests for any deep inequality. Opposite of `assert.deepEqual`. -## assert.strictEqual(actual, expected[, message]) +## assert.notDeepStrictEqual(actual, expected[, message]) -Tests strict equality as determined by the strict equality operator ( `===` ). +Tests for deep inequality. Opposite of `assert.deepStrictEqual`. + +## assert.notEqual(actual, expected[, message]) + +Tests shallow, coercive inequality with the not equal comparison operator +( `!=` ). ## assert.notStrictEqual(actual, expected[, message]) Tests strict inequality as determined by the strict not equal operator ( `!==` ). -## assert.deepStrictEqual(actual, expected[, message]) - -Tests for deep equality. Primitive values are compared with the strict equality -operator ( `===` ). - -## assert.notDeepStrictEqual(actual, expected[, message]) +## assert.strictEqual(actual, expected[, message]) -Tests for deep inequality. Opposite of `assert.deepStrictEqual`. +Tests strict equality as determined by the strict equality operator ( `===` ). ## assert.throws(block[, error][, message]) @@ -97,34 +128,3 @@ Custom error validation: }, "unexpected error" ); - -## assert.doesNotThrow(block[, error][, message]) - -Expects `block` not to throw an error. See [assert.throws()](#assert_assert_throws_block_error_message) for more details. - -If `block` throws an error and if it is of a different type from `error`, the -thrown error will get propagated back to the caller. The following call will -throw the `TypeError`, since we're not matching the error types in the -assertion. - - assert.doesNotThrow( - function() { - throw new TypeError("Wrong value"); - }, - SyntaxError - ); - -In case `error` matches with the error thrown by `block`, an `AssertionError` -is thrown instead. - - assert.doesNotThrow( - function() { - throw new TypeError("Wrong value"); - }, - TypeError - ); - -## assert.ifError(value) - -Throws `value` if `value` is truthy. This is useful when testing the `error` -argument in callbacks.