Skip to content

Commit

Permalink
Document that deepEqual() uses lodash.isequal
Browse files Browse the repository at this point in the history
  • Loading branch information
novemberborn authored and sindresorhus committed Feb 18, 2017
1 parent 2ff56ce commit d47c5c8
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions readme.md
Expand Up @@ -914,11 +914,15 @@ Assert that `value` is not equal to `expected`.

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

Assert that `value` is deep equal to `expected`.
Assert that `value` is deep equal to `expected`. This is based on [Lodash' `isEqual()`](https://lodash.com/docs/4.17.4#isEqual):

> Performs a deep comparison between two values to determine if they are equivalent.
>
> *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. `===`.
### `.notDeepEqual(value, expected, [message])`

Assert that `value` is not deep equal to `expected`.
Assert that `value` is not deep equal to `expected`. The inverse of `.deepEqual()`.

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

Expand Down

0 comments on commit d47c5c8

Please sign in to comment.