Skip to content

Commit d47c5c8

Browse files
novemberbornsindresorhus
authored andcommitted
Document that deepEqual() uses lodash.isequal
1 parent 2ff56ce commit d47c5c8

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -914,11 +914,15 @@ Assert that `value` is not equal to `expected`.
914914

915915
### `.deepEqual(value, expected, [message])`
916916

917-
Assert that `value` is deep equal to `expected`.
917+
Assert that `value` is deep equal to `expected`. This is based on [Lodash' `isEqual()`](https://lodash.com/docs/4.17.4#isEqual):
918+
919+
> Performs a deep comparison between two values to determine if they are equivalent.
920+
>
921+
> *Note*: This method supports comparing arrays, array buffers, booleans, date objects, error objects, maps, numbers, `Object` objects, regexes, sets, strings, symbols, and typed arrays. `Object` objects are compared by their own, not inherited, enumerable properties. Functions and DOM nodes are compared by strict equality, i.e. `===`.
918922
919923
### `.notDeepEqual(value, expected, [message])`
920924

921-
Assert that `value` is not deep equal to `expected`.
925+
Assert that `value` is not deep equal to `expected`. The inverse of `.deepEqual()`.
922926

923927
### `.throws(function|promise, [error, [message]])`
924928

0 commit comments

Comments
 (0)