Skip to content

doc: Fix message type in Assert docs #16427

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
wants to merge 1 commit into from
Closed

doc: Fix message type in Assert docs #16427

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
26 changes: 13 additions & 13 deletions doc/api/assert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ test invariants.
added: v0.5.9
-->
* `value` {any}
* `message` {any}
* `message` {string|undefined}

An alias of [`assert.ok()`][].

Expand All @@ -38,7 +38,7 @@ changes:
-->
* `actual` {any}
* `expected` {any}
* `message` {any}
* `message` {string|undefined}

Tests for deep equality between the `actual` and `expected` parameters.
Primitive values are compared with the [Abstract Equality Comparison][]
Expand Down Expand Up @@ -132,7 +132,7 @@ changes:
-->
* `actual` {any}
* `expected` {any}
* `message` {any}
* `message` {string|undefined}

Similar to `assert.deepEqual()` with the following exceptions:

Expand Down Expand Up @@ -216,7 +216,7 @@ changes:
-->
* `block` {Function}
* `error` {RegExp|Function}
* `message` {any}
* `message` {string|undefined}

Asserts that the function `block` does not throw an error. See
[`assert.throws()`][] for more details.
Expand Down Expand Up @@ -274,7 +274,7 @@ added: v0.1.21
-->
* `actual` {any}
* `expected` {any}
* `message` {any}
* `message` {string|undefined}

Tests shallow, coercive equality between the `actual` and `expected` parameters
using the [Abstract Equality Comparison][] ( `==` ).
Expand Down Expand Up @@ -306,7 +306,7 @@ added: v0.1.21
-->
* `actual` {any}
* `expected` {any}
* `message` {any} **Default:** `'Failed'`
* `message` {string|undefined} **Default:** `'Failed'`
* `operator` {string} **Default:** '!='
* `stackStartFunction` {function} **Default:** `assert.fail`

Expand Down Expand Up @@ -407,7 +407,7 @@ changes:
-->
* `actual` {any}
* `expected` {any}
* `message` {any}
* `message` {string|undefined}

Tests for any deep inequality. Opposite of [`assert.deepEqual()`][].

Expand Down Expand Up @@ -478,7 +478,7 @@ changes:
-->
* `actual` {any}
* `expected` {any}
* `message` {any}
* `message` {string|undefined}

Tests for deep strict inequality. Opposite of [`assert.deepStrictEqual()`][].

Expand All @@ -504,7 +504,7 @@ added: v0.1.21
-->
* `actual` {any}
* `expected` {any}
* `message` {any}
* `message` {string|undefined}

Tests shallow, coercive inequality with the [Abstract Equality Comparison][]
( `!=` ).
Expand Down Expand Up @@ -534,7 +534,7 @@ added: v0.1.21
-->
* `actual` {any}
* `expected` {any}
* `message` {any}
* `message` {string|undefined}

Tests strict inequality as determined by the [Strict Equality Comparison][]
( `!==` ).
Expand Down Expand Up @@ -563,7 +563,7 @@ of the `AssertionError`.
added: v0.1.21
-->
* `value` {any}
* `message` {any}
* `message` {string|undefined}

Tests if `value` is truthy. It is equivalent to
`assert.equal(!!value, true, message)`.
Expand Down Expand Up @@ -595,7 +595,7 @@ added: v0.1.21
-->
* `actual` {any}
* `expected` {any}
* `message` {any}
* `message` {string|undefined}

Tests strict equality as determined by the [Strict Equality Comparison][]
( `===` ).
Expand Down Expand Up @@ -629,7 +629,7 @@ changes:
-->
* `block` {Function}
* `error` {RegExp|Function}
* `message` {any}
* `message` {string|undefined}

Expects the function `block` to throw an error.

Expand Down