Skip to content
This repository was archived by the owner on Aug 31, 2018. It is now read-only.

Commit ebe7caa

Browse files
Trottaddaleax
Trott
authored and
addaleax
committed
util,assert: expose util.isDeepStrictEqual()
Provide `util.isDeepStrictEqual()` that works like `assert.deepStrictEqual()` but returns a boolean rather than throwing an error. Several userland modules have needed this functionality and implemented it independently. This functionality already exists in Node.js core, so this exposes it for use by modules. Modules that have needed this functionality include `lodash`, `concordance` (used by `ava`), and `qunit`. PR-URL: nodejs/node#16084 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent 63efd04 commit ebe7caa

7 files changed

Lines changed: 1028 additions & 504 deletions

File tree

‎doc/api/assert.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ changes:
134134
* `expected` {any}
135135
* `message` {any}
136136

137-
Similar to `assert.deepEqual()` with the following exceptions:
137+
Identical to [`assert.deepEqual()`][] with the following exceptions:
138138

139139
1. Primitive values besides `NaN` are compared using the [Strict Equality
140140
Comparison][] ( `===` ). Set and Map values, Map keys and `NaN` are compared

‎doc/api/util.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -455,6 +455,21 @@ util.inspect.defaultOptions.maxArrayLength = null;
455455
console.log(arr); // logs the full array
456456
```
457457

458+
## util.isDeepStrictEqual(val1, val2)
459+
<!-- YAML
460+
added: REPLACEME
461+
-->
462+
463+
* `val1` {any}
464+
* `val2` {any}
465+
* Returns: {string}
466+
467+
Returns `true` if there is deep strict equality between `val` and `val2`.
468+
Otherwise, returns `false`.
469+
470+
See [`assert.deepStrictEqual()`][] for more information about deep strict
471+
equality.
472+
458473
## util.promisify(original)
459474
<!-- YAML
460475
added: v8.0.0
@@ -1187,6 +1202,7 @@ Deprecated predecessor of `console.log`.
11871202
[`Buffer.isBuffer()`]: buffer.html#buffer_class_method_buffer_isbuffer_obj
11881203
[`Error`]: errors.html#errors_class_error
11891204
[`Object.assign()`]: https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign
1205+
[`assert.deepStrictEqual()`]: assert.html#assert_assert_deepstrictequal_actual_expected_message
11901206
[`console.error()`]: console.html#console_console_error_data_args
11911207
[`console.log()`]: console.html#console_console_log_data_args
11921208
[`util.inspect()`]: #util_util_inspect_object_options

0 commit comments

Comments
 (0)