Blame view

node_modules/assert/README.md 2.25 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
62
63
64
  # assert
  
  [![Build Status](https://travis-ci.org/defunctzombie/commonjs-assert.svg?branch=master)](https://travis-ci.org/defunctzombie/commonjs-assert)
  
  This module is used for writing unit tests for your applications, you can access it with require('assert').
  
  The API is derived from the [commonjs 1.0 unit testing](http://wiki.commonjs.org/wiki/Unit_Testing/1.0) spec and the [node.js assert module](http://nodejs.org/api/assert.html)
  
  ## assert.fail(actual, expected, message, operator)
  Throws an exception that displays the values for actual and expected separated by the provided operator.
  
  ## assert(value, message), assert.ok(value, [message])
  Tests if value is truthy, it is equivalent to assert.equal(true, !!value, message);
  
  ## assert.equal(actual, expected, [message])
  Tests shallow, coercive equality with the equal comparison operator ( == ).
  
  ## assert.notEqual(actual, expected, [message])
  Tests shallow, coercive non-equality with the not equal comparison operator ( != ).
  
  ## assert.deepEqual(actual, expected, [message])
  Tests for deep equality.
  
  ## assert.notDeepEqual(actual, expected, [message])
  Tests for any deep inequality.
  
  ## assert.strictEqual(actual, expected, [message])
  Tests strict equality, as determined by the strict equality operator ( === )
  
  ## assert.notStrictEqual(actual, expected, [message])
  Tests strict non-equality, as determined by the strict not equal operator ( !== )
  
  ## assert.throws(block, [error], [message])
  Expects block to throw an error. error can be constructor, regexp or validation function.
  
  Validate instanceof using constructor:
  
  ```javascript
  assert.throws(function() { throw new Error("Wrong value"); }, Error);
  ```
  
  Validate error message using RegExp:
  
  ```javascript
  assert.throws(function() { throw new Error("Wrong value"); }, /value/);
  ```
  
  Custom error validation:
  
  ```javascript
  assert.throws(function() {
      throw new Error("Wrong value");
  }, function(err) {
      if ( (err instanceof Error) && /value/.test(err) ) {
          return true;
      }
  }, "unexpected error");
  ```
  
  ## assert.doesNotThrow(block, [message])
  Expects block not to throw an error, see assert.throws for details.
  
  ## assert.ifError(value)
  Tests if value is not a false value, throws if it is a true value. Useful when testing the first argument, error in callbacks.