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: add docs for AssertionError #14261

Closed
wants to merge 2 commits into from
Closed

doc: add docs for AssertionError #14261

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4c6b23
doc: add docs for AssertionError
Jul 16, 2017
3958388
doc: use strictEqual instead of equal
Jul 16, 2017
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
12 changes: 12 additions & 0 deletions doc/api/errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,18 @@ loop tick.
System-level errors are generated as augmented `Error` instances, which are
detailed [here](#errors_system_errors).

## Class: AssertionError

A subclass of `Error` that indicates the failure of an assertion. Such errors
commonly indicate inequality of actual and expected parameters.
Copy link
Member

Choose a reason for hiding this comment

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

IMO this could as well be "values" instead of "parameters", still LGTM.


For example:

```js
assert.equal(1, 2);
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd recommend using strictEqual() here to help set readers up for success :-)

// AssertionError [ERR_ASSERTION]: 1 == 2
```

## Class: RangeError

A subclass of `Error` that indicates that a provided argument was not within the
Expand Down