Blame view

node_modules/deep-equal/readme.markdown 1.24 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
  # deep-equal
  
  Node's `assert.deepEqual() algorithm` as a standalone module.
  
  This module is around [5 times faster](https://gist.github.com/2790507)
  than wrapping `assert.deepEqual()` in a `try/catch`.
  
  [![browser support](https://ci.testling.com/substack/node-deep-equal.png)](https://ci.testling.com/substack/node-deep-equal)
  
  [![build status](https://secure.travis-ci.org/substack/node-deep-equal.png)](https://travis-ci.org/substack/node-deep-equal)
  
  # example
  
  ``` js
  var equal = require('deep-equal');
  console.dir([
      equal(
          { a : [ 2, 3 ], b : [ 4 ] },
          { a : [ 2, 3 ], b : [ 4 ] }
      ),
      equal(
          { x : 5, y : [6] },
          { x : 5, y : 6 }
      )
  ]);
  ```
  
  # methods
  
  ``` js
  var deepEqual = require('deep-equal')
  ```
  
  ## deepEqual(a, b, opts)
  
  Compare objects `a` and `b`, returning whether they are equal according to a
  recursive equality algorithm.
  
  If `opts.strict` is `true`, use strict equality (`===`) to compare leaf nodes.
  The default is to use coercive equality (`==`) because that's how
  `assert.deepEqual()` works by default.
  
  # install
  
  With [npm](http://npmjs.org) do:
  
  ```
  npm install deep-equal
  ```
  
  # test
  
  With [npm](http://npmjs.org) do:
  
  ```
  npm test
  ```
  
  # license
  
  MIT. Derived largely from node's assert module.