Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 168c127

Browse filesBrowse files
Trotttargos
authored andcommitted
doc: tidy AssertionError text
Several minor improvements to text. Remove some repetition. PR-URL: #28255 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent d949ead commit 168c127
Copy full SHA for 168c127

File tree

Expand file treeCollapse file tree

1 file changed

+12
-19
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+12
-19
lines changed
Open diff view settings
Collapse file

‎doc/api/assert.md‎

Copy file name to clipboardExpand all lines: doc/api/assert.md
+12-19Lines changed: 12 additions & 19 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -21,33 +21,26 @@ thrown by the `assert` module will be instances of the `AssertionError` class.
2121
added: v0.1.21
2222
-->
2323
* `options` {Object}
24-
* `message` {string} If provided, the error message is going to be set to this
25-
value.
26-
* `actual` {any} The `actual` property on the error instance is going to
27-
contain this value. Internally used for the `actual` error input in case
28-
e.g., [`assert.strictEqual()`] is used.
29-
* `expected` {any} The `expected` property on the error instance is going to
30-
contain this value. Internally used for the `expected` error input in case
31-
e.g., [`assert.strictEqual()`] is used.
32-
* `operator` {string} The `operator` property on the error instance is going
33-
to contain this value. Internally used to indicate what operation was used
34-
for comparison (or what assertion function triggered the error).
35-
* `stackStartFn` {Function} If provided, the generated stack trace is going to
36-
remove all frames up to the provided function.
24+
* `message` {string} If provided, the error message is set to this value.
25+
* `actual` {any} The `actual` property on the error instance.
26+
* `expected` {any} The `expected` property on the error instance.
27+
* `operator` {string} The `operator` property on the error instance.
28+
* `stackStartFn` {Function} If provided, the generated stack trace omits
29+
frames before this function.
3730

3831
A subclass of `Error` that indicates the failure of an assertion.
3932

4033
All instances contain the built-in `Error` properties (`message` and `name`)
4134
and:
4235

43-
* `actual` {any} Set to the actual value in case e.g.,
44-
[`assert.strictEqual()`] is used.
45-
* `expected` {any} Set to the expected value in case e.g.,
46-
[`assert.strictEqual()`] is used.
36+
* `actual` {any} Set to the `actual` argument for methods such as
37+
[`assert.strictEqual()`].
38+
* `expected` {any} Set to the `expected` value for methods such as
39+
[`assert.strictEqual()`].
4740
* `generatedMessage` {boolean} Indicates if the message was auto-generated
4841
(`true`) or not.
49-
* `code` {string} This is always set to the string `ERR_ASSERTION` to indicate
50-
that the error is actually an assertion error.
42+
* `code` {string} Value is always `ERR_ASSERTION` to show that the error is an
43+
assertion error.
5144
* `operator` {string} Set to the passed in operator value.
5245

5346
```js

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.