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.

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: sort documentation alphabetically #3662

Closed
wants to merge 32 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
ecd2179
doc: sort assert alphabetically
tflanagan Nov 4, 2015
63a2e55
doc: sort buffer alphabetically
tflanagan Nov 4, 2015
7b4f78a
doc: sort child_process alphabetically
tflanagan Nov 4, 2015
e650680
doc: sort cluster alphabetically
tflanagan Nov 4, 2015
cfed942
doc: sort console alphabetically
tflanagan Nov 4, 2015
03dd92c
doc: sort dns alphabetically
tflanagan Nov 4, 2015
d9e5b6a
doc: sort crypto alphabetically
tflanagan Nov 4, 2015
43f2da0
doc: sort dgram alphabetically
tflanagan Nov 4, 2015
b85d3ac
doc: sort errors alphabetically
tflanagan Nov 4, 2015
03129f8
doc: sort events alphabetically
tflanagan Nov 4, 2015
c44523a
doc: sort fs alphabetically
tflanagan Nov 4, 2015
0c181d1
doc: sort globals alphabetically
tflanagan Nov 4, 2015
99c8160
doc: sort os alphabetically
tflanagan Nov 4, 2015
820506e
doc: sort path alphabetically
tflanagan Nov 4, 2015
33a6975
doc: sort punycode alphabetically
tflanagan Nov 4, 2015
5c37462
doc: sort querystring alphabetically
tflanagan Nov 4, 2015
ac62941
doc: sort vm alphabetically
tflanagan Nov 4, 2015
8c83054
doc: sort url alphabetically
tflanagan Nov 4, 2015
cc6f224
doc: sort tty alphabetically
tflanagan Nov 4, 2015
15a8370
doc: sort timers alphabetically
tflanagan Nov 4, 2015
da7afdc
doc: sort string_decoder alphabetically
tflanagan Nov 4, 2015
059c98a
doc: sort repl alphabetically
tflanagan Nov 4, 2015
7ccad23
doc: sort readline alphabetically
tflanagan Nov 4, 2015
89122ce
doc: sort modules alphabetically
tflanagan Nov 4, 2015
3595327
doc: sort http alphabetically
tflanagan Nov 4, 2015
bed67d2
doc: sort https alphabetically
tflanagan Nov 4, 2015
5b09a1c
doc: sort util alphabetically
tflanagan Nov 5, 2015
37d037b
doc: sort zlib alphabetically
tflanagan Nov 5, 2015
8dbd518
doc: sort process alphabetically
tflanagan Nov 5, 2015
9811315
doc: sort net alphabetically
tflanagan Nov 5, 2015
e8c1e06
doc: sort stream alphabetically
tflanagan Nov 5, 2015
1b86f37
doc: sort tls alphabetically
tflanagan Nov 5, 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
108 changes: 54 additions & 54 deletions doc/api/assert.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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])
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmmm, I'm not sure about count-point APIs like this, maybe group these under their opposites?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wrestled with that myself, but I figured the initial PR should have it 100% alphabetical. Discussion would then steer it in either direction.

I am not in favor of one or the other. I can see the pros/cons of both; Having a reliable system for navigating the reference, and of having async/Sync being together.


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])

Expand Down Expand Up @@ -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.
Loading