Skip to content

Commit

Permalink
document strict/loose deep equals
Browse files Browse the repository at this point in the history
  • Loading branch information
James Halliday committed Oct 14, 2013
1 parent 95f827d commit 785be99
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions readme.markdown
Expand Up @@ -125,21 +125,38 @@ Aliases: `t.notEquals()`, `t.notStrictEqual()`, `t.notStrictEquals()`,

Assert that `a` and `b` have the same structure and nested values using
[node's deepEqual() algorithm](https://github.com/substack/node-deep-equal)
with an optional description `msg`.
with strict comparisons (`===`) on leaf nodes and an optional description
`msg`.

Aliases: `t.deepEquals()`, `t.isEquivalent()`, `t.looseEqual()`,
`t.looseEquals()`, `t.same()`
Aliases: `t.deepEquals()`, `t.isEquivalent()`, `t.same()`

## t.notDeepEqual(a, b, msg)

Assert that `a` and `b` do not have the same structure and nested values using
[node's deepEqual() algorithm](https://github.com/substack/node-deep-equal)
with an optional description `msg`.
with strict comparisons (`===`) on leaf nodes and an optional description
`msg`.

Aliases: `t.notEquivalent()`, `t.notDeeply()`, `t.notSame()`,
`t.isNotDeepEqual()`, `t.isNotDeeply()`, `t.isNotEquivalent()`,
`t.isInequivalent()`

## t.deepLooseEqual(a, b, msg)

Assert that `a` and `b` have the same structure and nested values using
[node's deepEqual() algorithm](https://github.com/substack/node-deep-equal)
with loose comparisons (`==`) on leaf nodes and an optional description `msg`.

Aliases: `t.looseEqual()`, `t.looseEquals()`

## t.notDeepLooseEqual(a, b, msg)

Assert that `a` and `b` do not have the same structure and nested values using
[node's deepEqual() algorithm](https://github.com/substack/node-deep-equal)
with loose comparisons (`==`) on leaf nodes and an optional description `msg`.

Aliases: `t.notLooseEqual()`, `t.notLooseEquals()`

## t.throws(fn, expected, msg)

Assert that the function call `fn()` throws an exception.
Expand Down

0 comments on commit 785be99

Please sign in to comment.