Commit bfa3989
doc: argument types for assert methods
Refs: #9399
PR-URL: #11548
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>1 parent 6e5f6e3 commit bfa3989
1 file changed
Lines changed: 39 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -16,6 +16,8 @@ the module. | |||
| 16 | 16 | <!-- YAML | |
| 17 | 17 | added: v0.5.9 | |
| 18 | 18 | --> | |
| 19 | + * `value` {any} | ||
| 20 | + * `message` {any} | ||
| 19 | 21 | ||
| 20 | 22 | An alias of [`assert.ok()`][] . | |
| 21 | 23 | ||
@@ -38,6 +40,9 @@ assert(false, 'it\'s false'); | |||
| 38 | 40 | <!-- YAML | |
| 39 | 41 | added: v0.1.21 | |
| 40 | 42 | --> | |
| 43 | + * `actual` {any} | ||
| 44 | + * `expected` {any} | ||
| 45 | + * `message` {any} | ||
| 41 | 46 | ||
| 42 | 47 | Tests for deep equality between the `actual` and `expected` parameters. | |
| 43 | 48 | Primitive values are compared with the equal comparison operator ( `==` ). | |
@@ -99,6 +104,9 @@ parameter is undefined, a default error message is assigned. | |||
| 99 | 104 | <!-- YAML | |
| 100 | 105 | added: v1.2.0 | |
| 101 | 106 | --> | |
| 107 | + * `actual` {any} | ||
| 108 | + * `expected` {any} | ||
| 109 | + * `message` {any} | ||
| 102 | 110 | ||
| 103 | 111 | Generally identical to `assert.deepEqual()` with two exceptions. First, | |
| 104 | 112 | primitive values are compared using the strict equality operator ( `===` ). | |
@@ -123,6 +131,9 @@ parameter is undefined, a default error message is assigned. | |||
| 123 | 131 | <!-- YAML | |
| 124 | 132 | added: v0.1.21 | |
| 125 | 133 | --> | |
| 134 | + * `block` {Function} | ||
| 135 | + * `error` {RegExp|Function} | ||
| 136 | + * `message` {any} | ||
| 126 | 137 | ||
| 127 | 138 | Asserts that the function `block` does not throw an error. See | |
| 128 | 139 | [`assert.throws()`][] for more details. | |
@@ -178,6 +189,9 @@ assert.doesNotThrow( | |||
| 178 | 189 | <!-- YAML | |
| 179 | 190 | added: v0.1.21 | |
| 180 | 191 | --> | |
| 192 | + * `actual` {any} | ||
| 193 | + * `expected` {any} | ||
| 194 | + * `message` {any} | ||
| 181 | 195 | ||
| 182 | 196 | Tests shallow, coercive equality between the `actual` and `expected` parameters | |
| 183 | 197 | using the equal comparison operator ( `==` ). | |
@@ -204,6 +218,10 @@ parameter is undefined, a default error message is assigned. | |||
| 204 | 218 | <!-- YAML | |
| 205 | 219 | added: v0.1.21 | |
| 206 | 220 | --> | |
| 221 | + * `actual` {any} | ||
| 222 | + * `expected` {any} | ||
| 223 | + * `message` {any} | ||
| 224 | + * `operator` {String} | ||
| 207 | 225 | ||
| 208 | 226 | Throws an `AssertionError`. If `message` is falsy, the error message is set as | |
| 209 | 227 | the values of `actual` and `expected` separated by the provided `operator`. | |
@@ -223,6 +241,7 @@ assert.fail(1, 2, 'whoops', '>'); | |||
| 223 | 241 | <!-- YAML | |
| 224 | 242 | added: v0.1.97 | |
| 225 | 243 | --> | |
| 244 | + * `value` {any} | ||
| 226 | 245 | ||
| 227 | 246 | Throws `value` if `value` is truthy. This is useful when testing the `error` | |
| 228 | 247 | argument in callbacks. | |
@@ -244,6 +263,9 @@ assert.ifError(new Error()); | |||
| 244 | 263 | <!-- YAML | |
| 245 | 264 | added: v0.1.21 | |
| 246 | 265 | --> | |
| 266 | + * `actual` {any} | ||
| 267 | + * `expected` {any} | ||
| 268 | + * `message` {any} | ||
| 247 | 269 | ||
| 248 | 270 | Tests for any deep inequality. Opposite of [`assert.deepEqual()`][]. | |
| 249 | 271 | ||
@@ -288,6 +310,9 @@ parameter is undefined, a default error message is assigned. | |||
| 288 | 310 | <!-- YAML | |
| 289 | 311 | added: v1.2.0 | |
| 290 | 312 | --> | |
| 313 | + * `actual` {any} | ||
| 314 | + * `expected` {any} | ||
| 315 | + * `message` {any} | ||
| 291 | 316 | ||
| 292 | 317 | Tests for deep strict inequality. Opposite of [`assert.deepStrictEqual()`][]. | |
| 293 | 318 | ||
@@ -309,6 +334,9 @@ the `message` parameter is undefined, a default error message is assigned. | |||
| 309 | 334 | <!-- YAML | |
| 310 | 335 | added: v0.1.21 | |
| 311 | 336 | --> | |
| 337 | + * `actual` {any} | ||
| 338 | + * `expected` {any} | ||
| 339 | + * `message` {any} | ||
| 312 | 340 | ||
| 313 | 341 | Tests shallow, coercive inequality with the not equal comparison operator | |
| 314 | 342 | ( `!=` ). | |
@@ -334,6 +362,9 @@ parameter is undefined, a default error message is assigned. | |||
| 334 | 362 | <!-- YAML | |
| 335 | 363 | added: v0.1.21 | |
| 336 | 364 | --> | |
| 365 | + * `actual` {any} | ||
| 366 | + * `expected` {any} | ||
| 367 | + * `message` {any} | ||
| 337 | 368 | ||
| 338 | 369 | Tests strict inequality as determined by the strict not equal operator | |
| 339 | 370 | ( `!==` ). | |
@@ -359,6 +390,8 @@ If the values are strictly equal, an `AssertionError` is thrown with a | |||
| 359 | 390 | <!-- YAML | |
| 360 | 391 | added: v0.1.21 | |
| 361 | 392 | --> | |
| 393 | + * `value` {any} | ||
| 394 | + * `message` {any} | ||
| 362 | 395 | ||
| 363 | 396 | Tests if `value` is truthy. It is equivalent to | |
| 364 | 397 | `assert.equal(!!value, true, message)`. | |
@@ -386,6 +419,9 @@ assert.ok(false, 'it\'s false'); | |||
| 386 | 419 | <!-- YAML | |
| 387 | 420 | added: v0.1.21 | |
| 388 | 421 | --> | |
| 422 | + * `actual` {any} | ||
| 423 | + * `expected` {any} | ||
| 424 | + * `message` {any} | ||
| 389 | 425 | ||
| 390 | 426 | Tests strict equality as determined by the strict equality operator ( `===` ). | |
| 391 | 427 | ||
@@ -410,6 +446,9 @@ If the values are not strictly equal, an `AssertionError` is thrown with a | |||
| 410 | 446 | <!-- YAML | |
| 411 | 447 | added: v0.1.21 | |
| 412 | 448 | --> | |
| 449 | + * `block` {Function} | ||
| 450 | + * `error` {RegExp|Function} | ||
| 451 | + * `message` {any} | ||
| 413 | 452 | ||
| 414 | 453 | Expects the function `block` to throw an error. | |
| 415 | 454 | ||
0 commit comments