Skip to content
Permalink
Browse files

doc: revise strict mode text in assert

Revise the text describing `strict` mode.

PR-URL: #28285
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
  • Loading branch information...
Trott authored and targos committed Jun 19, 2019
1 parent c4a357d commit 1f2b8c8cabb9e1826e870af985ed1111dac99759
Showing with 7 additions and 7 deletions.
  1. +7 −7 doc/api/assert.md
@@ -6,7 +6,7 @@
The `assert` module provides a set of assertion functions for verifying
invariants. The module provides a recommended [`strict` mode][] and a more
lenient `legacy` mode.
lenient legacy mode.

For more information about the used equality comparisons see
[MDN's guide on equality comparisons and sameness][mdn-equality-guide].
@@ -80,14 +80,14 @@ changes:
description: Added strict mode to the assert module.
-->

When using the `strict` mode, any `assert` function will use the equality used
in the strict function mode. So [`assert.deepEqual()`][] will, for example,
work the same as [`assert.deepStrictEqual()`][].
In `strict` mode, `assert` functions use the comparison in the corresponding
strict functions. For example, [`assert.deepEqual()`][] will behave like
[`assert.deepStrictEqual()`][].

On top of that, error messages which involve objects produce an error diff
instead of displaying both objects. That is not the case for the legacy mode.
In `strict` mode, error messages for objects display a diff. In legacy mode,
error messages for objects display the objects, often truncated.

It can be accessed using:
To use `strict` mode:

```js
const assert = require('assert').strict;

0 comments on commit 1f2b8c8

Please sign in to comment.
You can’t perform that action at this time.