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.
  • Loading branch information
foliveira committed Sep 14, 2015
1 parent a1949e8 commit e8bb02f
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions doc/api/assert.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,27 @@ 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

0 comments on commit e8bb02f

Please sign in to comment.