Skip to content
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

doc: correct description of assert.ifError() #2941

Closed
wants to merge 3 commits into from
Closed

doc: correct description of assert.ifError() #2941

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af394c1
doc: correct description of assert.ifError()
Trott Sep 18, 2015
7c4a8f3
fixup: refine ifError() text
Trott Sep 18, 2015
2f7dbc6
fixup: non-equiality -> inequality
Trott Sep 18, 2015
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
19 changes: 10 additions & 9 deletions doc/api/assert.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Stability: 2 - Stable

This module is used for writing unit tests for your applications, you can
This module is used for writing unit tests for your applications. You can
access it with `require('assert')`.

## assert.fail(actual, expected, message, operator)
Expand All @@ -19,7 +19,8 @@ Tests shallow, coercive equality with the equal comparison operator ( `==` ).

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

Tests shallow, coercive non-equality with the not equal comparison operator ( `!=` ).
Tests shallow, coercive inequality with the not equal comparison operator
( `!=` ).

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

Expand All @@ -32,12 +33,12 @@ Tests for any deep inequality. Opposite of `assert.deepEqual`.

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

Tests strict equality, as determined by the strict equality operator ( `===` )
Tests strict equality as determined by the strict equality operator ( `===` ).

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

Tests strict non-equality, as determined by the strict not equal
operator ( `!==` )
Tests strict inequality as determined by the strict not equal operator
( `!==` ).

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

Expand All @@ -50,7 +51,7 @@ Tests for deep inequality. Opposite of `assert.deepStrictEqual`.

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

Expects `block` to throw an error. `error` can be constructor, `RegExp` or
Expects `block` to throw an error. `error` can be a constructor, `RegExp`, or
validation function.

Validate instanceof using constructor:
Expand Down Expand Up @@ -87,9 +88,9 @@ Custom error validation:

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

Expects `block` not to throw an error, see `assert.throws` for details.
Expects `block` not to throw an error. See `assert.throws()` for details.

## 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.
Throws `value` if `value` is truthy. This is useful when testing the `error`
argument in callbacks.