Skip to content

Commit

Permalink
docs: Clarify assert.doesNotThrow behavior
Browse files Browse the repository at this point in the history
The documentation for assert.doesNotThrow now reflects all the inputs
the function accepts, as well as the errors thrown for each combination
of parameter types.

PR-URL: #2807
Reviewed-By: Rich Trott <[email protected]>
  • Loading branch information
foliveira authored and Fishrock123 committed Sep 25, 2015
1 parent 9e9bfa4 commit b28f6a5
Showing 1 changed file with 28 additions and 4 deletions.
32 changes: 28 additions & 4 deletions doc/api/assert.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ access it with `require('assert')`.

## assert.fail(actual, expected, message, operator)

Throws an exception that displays the values for `actual` and `expected` separated by the provided 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(true, !!value, message)`.
Tests if value is truthy. It is equivalent to
`assert.equal(true, !!value, message)`.

## assert.equal(actual, expected[, message])

Expand Down Expand Up @@ -86,9 +88,31 @@ Custom error validation:
"unexpected error"
);

## assert.doesNotThrow(block[, message])
## assert.doesNotThrow(block[, error][, message])

Expects `block` not to throw an error. See `assert.throws()` for details.
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)

Expand Down

1 comment on commit b28f6a5

@rvagg
Copy link
Member

@rvagg rvagg commented on b28f6a5 Sep 29, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whoops, note this commit got in with docs: rather than doc:

Please sign in to comment.