Commit 09c9105
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 53f2848 commit 09c9105
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 | ||
@@ -36,6 +38,9 @@ assert(false, 'it\'s false'); | |||
| 36 | 38 | <!-- YAML | |
| 37 | 39 | added: v0.1.21 | |
| 38 | 40 | --> | |
| 41 | + * `actual` {any} | ||
| 42 | + * `expected` {any} | ||
| 43 | + * `message` {any} | ||
| 39 | 44 | ||
| 40 | 45 | Tests for deep equality between the `actual` and `expected` parameters. | |
| 41 | 46 | Primitive values are compared with the equal comparison operator ( `==` ). | |
@@ -97,6 +102,9 @@ parameter is undefined, a default error message is assigned. | |||
| 97 | 102 | <!-- YAML | |
| 98 | 103 | added: v1.2.0 | |
| 99 | 104 | --> | |
| 105 | + * `actual` {any} | ||
| 106 | + * `expected` {any} | ||
| 107 | + * `message` {any} | ||
| 100 | 108 | ||
| 101 | 109 | Generally identical to `assert.deepEqual()` with two exceptions. First, | |
| 102 | 110 | primitive values are compared using the strict equality operator ( `===` ). | |
@@ -121,6 +129,9 @@ parameter is undefined, a default error message is assigned. | |||
| 121 | 129 | <!-- YAML | |
| 122 | 130 | added: v0.1.21 | |
| 123 | 131 | --> | |
| 132 | + * `block` {Function} | ||
| 133 | + * `error` {RegExp|Function} | ||
| 134 | + * `message` {any} | ||
| 124 | 135 | ||
| 125 | 136 | Asserts that the function `block` does not throw an error. See | |
| 126 | 137 | [`assert.throws()`][] for more details. | |
@@ -176,6 +187,9 @@ assert.doesNotThrow( | |||
| 176 | 187 | <!-- YAML | |
| 177 | 188 | added: v0.1.21 | |
| 178 | 189 | --> | |
| 190 | + * `actual` {any} | ||
| 191 | + * `expected` {any} | ||
| 192 | + * `message` {any} | ||
| 179 | 193 | ||
| 180 | 194 | Tests shallow, coercive equality between the `actual` and `expected` parameters | |
| 181 | 195 | using the equal comparison operator ( `==` ). | |
@@ -202,6 +216,10 @@ parameter is undefined, a default error message is assigned. | |||
| 202 | 216 | <!-- YAML | |
| 203 | 217 | added: v0.1.21 | |
| 204 | 218 | --> | |
| 219 | + * `actual` {any} | ||
| 220 | + * `expected` {any} | ||
| 221 | + * `message` {any} | ||
| 222 | + * `operator` {String} | ||
| 205 | 223 | ||
| 206 | 224 | Throws an `AssertionError`. If `message` is falsy, the error message is set as | |
| 207 | 225 | the values of `actual` and `expected` separated by the provided `operator`. | |
@@ -221,6 +239,7 @@ assert.fail(1, 2, 'whoops', '>'); | |||
| 221 | 239 | <!-- YAML | |
| 222 | 240 | added: v0.1.97 | |
| 223 | 241 | --> | |
| 242 | + * `value` {any} | ||
| 224 | 243 | ||
| 225 | 244 | Throws `value` if `value` is truthy. This is useful when testing the `error` | |
| 226 | 245 | argument in callbacks. | |
@@ -238,6 +257,9 @@ assert.ifError(new Error()); // Throws Error | |||
| 238 | 257 | <!-- YAML | |
| 239 | 258 | added: v0.1.21 | |
| 240 | 259 | --> | |
| 260 | + * `actual` {any} | ||
| 261 | + * `expected` {any} | ||
| 262 | + * `message` {any} | ||
| 241 | 263 | ||
| 242 | 264 | Tests for any deep inequality. Opposite of [`assert.deepEqual()`][]. | |
| 243 | 265 | ||
@@ -282,6 +304,9 @@ parameter is undefined, a default error message is assigned. | |||
| 282 | 304 | <!-- YAML | |
| 283 | 305 | added: v1.2.0 | |
| 284 | 306 | --> | |
| 307 | + * `actual` {any} | ||
| 308 | + * `expected` {any} | ||
| 309 | + * `message` {any} | ||
| 285 | 310 | ||
| 286 | 311 | Tests for deep strict inequality. Opposite of [`assert.deepStrictEqual()`][]. | |
| 287 | 312 | ||
@@ -303,6 +328,9 @@ the `message` parameter is undefined, a default error message is assigned. | |||
| 303 | 328 | <!-- YAML | |
| 304 | 329 | added: v0.1.21 | |
| 305 | 330 | --> | |
| 331 | + * `actual` {any} | ||
| 332 | + * `expected` {any} | ||
| 333 | + * `message` {any} | ||
| 306 | 334 | ||
| 307 | 335 | Tests shallow, coercive inequality with the not equal comparison operator | |
| 308 | 336 | ( `!=` ). | |
@@ -328,6 +356,9 @@ parameter is undefined, a default error message is assigned. | |||
| 328 | 356 | <!-- YAML | |
| 329 | 357 | added: v0.1.21 | |
| 330 | 358 | --> | |
| 359 | + * `actual` {any} | ||
| 360 | + * `expected` {any} | ||
| 361 | + * `message` {any} | ||
| 331 | 362 | ||
| 332 | 363 | Tests strict inequality as determined by the strict not equal operator | |
| 333 | 364 | ( `!==` ). | |
@@ -353,6 +384,8 @@ If the values are strictly equal, an `AssertionError` is thrown with a | |||
| 353 | 384 | <!-- YAML | |
| 354 | 385 | added: v0.1.21 | |
| 355 | 386 | --> | |
| 387 | + * `value` {any} | ||
| 388 | + * `message` {any} | ||
| 356 | 389 | ||
| 357 | 390 | Tests if `value` is truthy. It is equivalent to | |
| 358 | 391 | `assert.equal(!!value, true, message)`. | |
@@ -378,6 +411,9 @@ assert.ok(false, 'it\'s false'); | |||
| 378 | 411 | <!-- YAML | |
| 379 | 412 | added: v0.1.21 | |
| 380 | 413 | --> | |
| 414 | + * `actual` {any} | ||
| 415 | + * `expected` {any} | ||
| 416 | + * `message` {any} | ||
| 381 | 417 | ||
| 382 | 418 | Tests strict equality as determined by the strict equality operator ( `===` ). | |
| 383 | 419 | ||
@@ -402,6 +438,9 @@ If the values are not strictly equal, an `AssertionError` is thrown with a | |||
| 402 | 438 | <!-- YAML | |
| 403 | 439 | added: v0.1.21 | |
| 404 | 440 | --> | |
| 441 | + * `block` {Function} | ||
| 442 | + * `error` {RegExp|Function} | ||
| 443 | + * `message` {any} | ||
| 405 | 444 | ||
| 406 | 445 | Expects the function `block` to throw an error. | |
| 407 | 446 | ||
0 commit comments