@@ -13,6 +13,9 @@ additions or changes to any of the methods implemented and exposed by
13
13
the module.
14
14
15
15
## assert(value[ , message] )
16
+ <!-- YAML
17
+ added: v0.5.9
18
+ -->
16
19
17
20
An alias of [ ` assert.ok() ` ] [ ] .
18
21
@@ -30,6 +33,9 @@ assert(false, 'it\'s false');
30
33
```
31
34
32
35
## assert.deepEqual(actual, expected[ , message] )
36
+ <!-- YAML
37
+ added: v0.1.21
38
+ -->
33
39
34
40
Tests for deep equality between the ` actual ` and ` expected ` parameters.
35
41
Primitive values are compared with the equal comparison operator ( ` == ` ).
@@ -88,6 +94,9 @@ property set equal to the value of the `message` parameter. If the `message`
88
94
parameter is undefined, a default error message is assigned.
89
95
90
96
## assert.deepStrictEqual(actual, expected[ , message] )
97
+ <!-- YAML
98
+ added: v1.2.0
99
+ -->
91
100
92
101
Generally identical to ` assert.deepEqual() ` with two exceptions. First,
93
102
primitive values are compared using the strict equality operator ( ` === ` ).
@@ -109,6 +118,9 @@ property set equal to the value of the `message` parameter. If the `message`
109
118
parameter is undefined, a default error message is assigned.
110
119
111
120
## assert.doesNotThrow(block[ , error] [ , message ] )
121
+ <!-- YAML
122
+ added: v0.1.21
123
+ -->
112
124
113
125
Asserts that the function ` block ` does not throw an error. See
114
126
[ ` assert.throws() ` ] [ ] for more details.
@@ -161,6 +173,9 @@ assert.doesNotThrow(
161
173
```
162
174
163
175
## assert.equal(actual, expected[ , message] )
176
+ <!-- YAML
177
+ added: v0.1.21
178
+ -->
164
179
165
180
Tests shallow, coercive equality between the ` actual ` and ` expected ` parameters
166
181
using the equal comparison operator ( ` == ` ).
@@ -184,6 +199,9 @@ property set equal to the value of the `message` parameter. If the `message`
184
199
parameter is undefined, a default error message is assigned.
185
200
186
201
## assert.fail(actual, expected, message, operator)
202
+ <!-- YAML
203
+ added: v0.1.21
204
+ -->
187
205
188
206
Throws an ` AssertionError ` . If ` message ` is falsy, the error message is set as
189
207
the values of ` actual ` and ` expected ` separated by the provided ` operator ` .
@@ -200,6 +218,9 @@ assert.fail(1, 2, 'whoops', '>');
200
218
```
201
219
202
220
## assert.ifError(value)
221
+ <!-- YAML
222
+ added: v0.1.97
223
+ -->
203
224
204
225
Throws ` value ` if ` value ` is truthy. This is useful when testing the ` error `
205
226
argument in callbacks.
@@ -214,6 +235,9 @@ assert.ifError(new Error()); // Throws Error
214
235
```
215
236
216
237
## assert.notDeepEqual(actual, expected[ , message] )
238
+ <!-- YAML
239
+ added: v0.1.21
240
+ -->
217
241
218
242
Tests for any deep inequality. Opposite of [ ` assert.deepEqual() ` ] [ ] .
219
243
@@ -255,6 +279,9 @@ property set equal to the value of the `message` parameter. If the `message`
255
279
parameter is undefined, a default error message is assigned.
256
280
257
281
## assert.notDeepStrictEqual(actual, expected[ , message] )
282
+ <!-- YAML
283
+ added: v1.2.0
284
+ -->
258
285
259
286
Tests for deep strict inequality. Opposite of [ ` assert.deepStrictEqual() ` ] [ ] .
260
287
@@ -273,6 +300,9 @@ with a `message` property set equal to the value of the `message` parameter. If
273
300
the ` message ` parameter is undefined, a default error message is assigned.
274
301
275
302
## assert.notEqual(actual, expected[ , message] )
303
+ <!-- YAML
304
+ added: v0.1.21
305
+ -->
276
306
277
307
Tests shallow, coercive inequality with the not equal comparison operator
278
308
( ` != ` ).
@@ -295,6 +325,9 @@ property set equal to the value of the `message` parameter. If the `message`
295
325
parameter is undefined, a default error message is assigned.
296
326
297
327
## assert.notStrictEqual(actual, expected[ , message] )
328
+ <!-- YAML
329
+ added: v0.1.21
330
+ -->
298
331
299
332
Tests strict inequality as determined by the strict not equal operator
300
333
( ` !== ` ).
@@ -317,6 +350,9 @@ If the values are strictly equal, an `AssertionError` is thrown with a
317
350
` message ` parameter is undefined, a default error message is assigned.
318
351
319
352
## assert.ok(value[ , message] )
353
+ <!-- YAML
354
+ added: v0.1.21
355
+ -->
320
356
321
357
Tests if ` value ` is truthy. It is equivalent to
322
358
` assert.equal(!!value, true, message) ` .
@@ -339,6 +375,9 @@ assert.ok(false, 'it\'s false');
339
375
```
340
376
341
377
## assert.strictEqual(actual, expected[ , message] )
378
+ <!-- YAML
379
+ added: v0.1.21
380
+ -->
342
381
343
382
Tests strict equality as determined by the strict equality operator ( ` === ` ).
344
383
@@ -360,6 +399,9 @@ If the values are not strictly equal, an `AssertionError` is thrown with a
360
399
` message ` parameter is undefined, a default error message is assigned.
361
400
362
401
## assert.throws(block[ , error] [ , message ] )
402
+ <!-- YAML
403
+ added: v0.1.21
404
+ -->
363
405
364
406
Expects the function ` block ` to throw an error.
365
407
0 commit comments