Skip to content

docs: Clarify assert.doesNotThrow behavior #2807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
foliveira wants to merge 1 commit into from
Closed

docs: Clarify assert.doesNotThrow behavior #2807

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs: Clarify assert.doesNotThrow behavior 
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
foliveira committed Sep 14, 2015
commit e8bb02f246861a93ff741d2a10699247daa73bec
22 changes: 20 additions & 2 deletions doc/api/assert.markdown
View file
Open in desktop
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