1
1
# Assert
2
+ <!-- YAML
3
+ added: v0.1.21
4
+ -->
2
5
3
6
Stability: 3 - Locked
4
7
@@ -12,7 +15,14 @@ The API for the `assert` module is [Locked][]. This means that there will be no
12
15
additions or changes to any of the methods implemented and exposed by
13
16
the module.
14
17
15
- ## assert(value[ , message] ), assert.ok(value[ , message] )
18
+ ## assert(value[ , message] )
19
+ <!-- YAML
20
+ added: v0.5.9
21
+ -->
22
+ ## assert.ok(value[ , message] )
23
+ <!-- YAML
24
+ added: v0.1.21
25
+ -->
16
26
17
27
Tests if ` value ` is truthy. It is equivalent to
18
28
` assert.equal(!!value, true, message) ` .
@@ -44,6 +54,9 @@ assert.ok(false, 'it\'s false');
44
54
```
45
55
46
56
## assert.deepEqual(actual, expected[ , message] )
57
+ <!-- YAML
58
+ added: v0.1.21
59
+ -->
47
60
48
61
Tests for deep equality between the ` actual ` and ` expected ` parameters.
49
62
Primitive values are compared with the equal comparison operator ( ` == ` ).
@@ -102,6 +115,9 @@ property set equal to the value of the `message` parameter. If the `message`
102
115
parameter is undefined, a default error message is assigned.
103
116
104
117
## assert.deepStrictEqual(actual, expected[ , message] )
118
+ <!-- YAML
119
+ added: v1.2.0
120
+ -->
105
121
106
122
Generally identical to ` assert.deepEqual ` with the exception that primitive
107
123
values are compared using the strict equality operator ( ` === ` ).
@@ -122,6 +138,9 @@ property set equal to the value of the `message` parameter. If the `message`
122
138
parameter is undefined, a default error message is assigned.
123
139
124
140
## assert.doesNotThrow(block[ , error] [ , message ] )
141
+ <!-- YAML
142
+ added: v0.1.21
143
+ -->
125
144
126
145
Asserts that the function ` block ` does not throw an error. See
127
146
[ ` assert.throws() ` ] [ ] for more details.
@@ -174,6 +193,9 @@ assert.doesNotThrow(
174
193
```
175
194
176
195
## assert.equal(actual, expected[ , message] )
196
+ <!-- YAML
197
+ added: v0.1.21
198
+ -->
177
199
178
200
Tests shallow, coercive equality between the ` actual ` and ` expected ` parameters
179
201
using the equal comparison operator ( ` == ` ).
@@ -197,6 +219,9 @@ property set equal to the value of the `message` parameter. If the `message`
197
219
parameter is undefined, a default error message is assigned.
198
220
199
221
## assert.fail(actual, expected, message, operator)
222
+ <!-- YAML
223
+ added: v0.1.21
224
+ -->
200
225
201
226
Throws an ` AssertionError ` . If ` message ` is falsy, the error message is set as
202
227
the values of ` actual ` and ` expected ` separated by the provided ` operator ` .
@@ -213,6 +238,9 @@ assert.fail(1, 2, 'whoops', '>');
213
238
```
214
239
215
240
## assert.ifError(value)
241
+ <!-- YAML
242
+ added: v0.1.97
243
+ -->
216
244
217
245
Throws ` value ` if ` value ` is truthy. This is useful when testing the ` error `
218
246
argument in callbacks.
@@ -227,6 +255,9 @@ assert.ifError(new Error()); // Throws Error
227
255
```
228
256
229
257
## assert.notDeepEqual(actual, expected[ , message] )
258
+ <!-- YAML
259
+ added: v0.1.21
260
+ -->
230
261
231
262
Tests for any deep inequality. Opposite of [ ` assert.deepEqual ` ] [ ] .
232
263
@@ -268,6 +299,9 @@ property set equal to the value of the `message` parameter. If the `message`
268
299
parameter is undefined, a default error message is assigned.
269
300
270
301
## assert.notDeepStrictEqual(actual, expected[ , message] )
302
+ <!-- YAML
303
+ added: v1.2.0
304
+ -->
271
305
272
306
Tests for deep strict inequality. Opposite of [ ` assert.deepStrictEqual ` ] [ ] .
273
307
@@ -286,6 +320,9 @@ with a `message` property set equal to the value of the `message` parameter. If
286
320
the ` message ` parameter is undefined, a default error message is assigned.
287
321
288
322
## assert.notEqual(actual, expected[ , message] )
323
+ <!-- YAML
324
+ added: v0.1.21
325
+ -->
289
326
290
327
Tests shallow, coercive inequality with the not equal comparison operator
291
328
( ` != ` ).
@@ -308,6 +345,9 @@ property set equal to the value of the `message` parameter. If the `message`
308
345
parameter is undefined, a default error message is assigned.
309
346
310
347
## assert.notStrictEqual(actual, expected[ , message] )
348
+ <!-- YAML
349
+ added: v0.1.21
350
+ -->
311
351
312
352
Tests strict inequality as determined by the strict not equal operator
313
353
( ` !== ` ).
@@ -330,6 +370,9 @@ If the values are strictly equal, an `AssertionError` is thrown with a
330
370
` message ` parameter is undefined, a default error message is assigned.
331
371
332
372
## assert.strictEqual(actual, expected[ , message] )
373
+ <!-- YAML
374
+ added: v0.1.21
375
+ -->
333
376
334
377
Tests strict equality as determined by the strict equality operator ( ` === ` ).
335
378
@@ -351,6 +394,9 @@ If the values are not strictly equal, an `AssertionError` is thrown with a
351
394
` message ` parameter is undefined, a default error message is assigned.
352
395
353
396
## assert.throws(block[ , error] [ , message ] )
397
+ <!-- YAML
398
+ added: v0.1.21
399
+ -->
354
400
355
401
Expects the function ` block ` to throw an error. If specified, ` error ` can be a
356
402
constructor, [ ` RegExp ` ] [ ] , or validation function.
0 commit comments