Blame view

node_modules/deep-is/README.markdown 1.41 KB
f7563de62   Palak Handa   first commit
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
62
63
64
65
66
67
68
69
70
  deep-is
  ==========
  
  Node's `assert.deepEqual() algorithm` as a standalone module. Exactly like
  [deep-equal](https://github.com/substack/node-deep-equal) except for the fact that `deepEqual(NaN, NaN) === true`.
  
  This module is around [5 times faster](https://gist.github.com/2790507)
  than wrapping `assert.deepEqual()` in a `try/catch`.
  
  [![browser support](http://ci.testling.com/thlorenz/deep-is.png)](http://ci.testling.com/thlorenz/deep-is)
  
  [![build status](https://secure.travis-ci.org/thlorenz/deep-is.png)](http://travis-ci.org/thlorenz/deep-is)
  
  example
  =======
  
  ``` js
  var equal = require('deep-is');
  console.dir([
      equal(
          { a : [ 2, 3 ], b : [ 4 ] },
          { a : [ 2, 3 ], b : [ 4 ] }
      ),
      equal(
          { x : 5, y : [6] },
          { x : 5, y : 6 }
      )
  ]);
  ```
  
  methods
  =======
  
  var deepIs = require('deep-is')
  
  deepIs(a, b)
  ---------------
  
  Compare objects `a` and `b`, returning whether they are equal according to a
  recursive equality algorithm.
  
  install
  =======
  
  With [npm](http://npmjs.org) do:
  
  ```
  npm install deep-is
  ```
  
  test
  ====
  
  With [npm](http://npmjs.org) do:
  
  ```
  npm test
  ```
  
  license
  =======
  
  Copyright (c) 2012, 2013 Thorsten Lorenz <thlorenz@gmx.de>
  Copyright (c) 2012 James Halliday <mail@substack.net>
  
  Derived largely from node's assert module, which has the copyright statement:
  
  Copyright (c) 2009 Thomas Robinson <280north.com>
  
  Released under the MIT license, see LICENSE for details.