Skip to content

Commit bfa3989

Browse files
ameliavoncatMylesBorins
authored andcommitted
doc: argument types for assert methods
Refs: #9399 PR-URL: #11548 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
1 parent 6e5f6e3 commit bfa3989

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

doc/api/assert.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ the module.
1616
<!-- YAML
1717
added: v0.5.9
1818
-->
19+
* `value` {any}
20+
* `message` {any}
1921

2022
An alias of [`assert.ok()`][] .
2123

@@ -38,6 +40,9 @@ assert(false, 'it\'s false');
3840
<!-- YAML
3941
added: v0.1.21
4042
-->
43+
* `actual` {any}
44+
* `expected` {any}
45+
* `message` {any}
4146

4247
Tests for deep equality between the `actual` and `expected` parameters.
4348
Primitive values are compared with the equal comparison operator ( `==` ).
@@ -99,6 +104,9 @@ parameter is undefined, a default error message is assigned.
99104
<!-- YAML
100105
added: v1.2.0
101106
-->
107+
* `actual` {any}
108+
* `expected` {any}
109+
* `message` {any}
102110

103111
Generally identical to `assert.deepEqual()` with two exceptions. First,
104112
primitive values are compared using the strict equality operator ( `===` ).
@@ -123,6 +131,9 @@ parameter is undefined, a default error message is assigned.
123131
<!-- YAML
124132
added: v0.1.21
125133
-->
134+
* `block` {Function}
135+
* `error` {RegExp|Function}
136+
* `message` {any}
126137

127138
Asserts that the function `block` does not throw an error. See
128139
[`assert.throws()`][] for more details.
@@ -178,6 +189,9 @@ assert.doesNotThrow(
178189
<!-- YAML
179190
added: v0.1.21
180191
-->
192+
* `actual` {any}
193+
* `expected` {any}
194+
* `message` {any}
181195

182196
Tests shallow, coercive equality between the `actual` and `expected` parameters
183197
using the equal comparison operator ( `==` ).
@@ -204,6 +218,10 @@ parameter is undefined, a default error message is assigned.
204218
<!-- YAML
205219
added: v0.1.21
206220
-->
221+
* `actual` {any}
222+
* `expected` {any}
223+
* `message` {any}
224+
* `operator` {String}
207225

208226
Throws an `AssertionError`. If `message` is falsy, the error message is set as
209227
the values of `actual` and `expected` separated by the provided `operator`.
@@ -223,6 +241,7 @@ assert.fail(1, 2, 'whoops', '>');
223241
<!-- YAML
224242
added: v0.1.97
225243
-->
244+
* `value` {any}
226245

227246
Throws `value` if `value` is truthy. This is useful when testing the `error`
228247
argument in callbacks.
@@ -244,6 +263,9 @@ assert.ifError(new Error());
244263
<!-- YAML
245264
added: v0.1.21
246265
-->
266+
* `actual` {any}
267+
* `expected` {any}
268+
* `message` {any}
247269

248270
Tests for any deep inequality. Opposite of [`assert.deepEqual()`][].
249271

@@ -288,6 +310,9 @@ parameter is undefined, a default error message is assigned.
288310
<!-- YAML
289311
added: v1.2.0
290312
-->
313+
* `actual` {any}
314+
* `expected` {any}
315+
* `message` {any}
291316

292317
Tests for deep strict inequality. Opposite of [`assert.deepStrictEqual()`][].
293318

@@ -309,6 +334,9 @@ the `message` parameter is undefined, a default error message is assigned.
309334
<!-- YAML
310335
added: v0.1.21
311336
-->
337+
* `actual` {any}
338+
* `expected` {any}
339+
* `message` {any}
312340

313341
Tests shallow, coercive inequality with the not equal comparison operator
314342
( `!=` ).
@@ -334,6 +362,9 @@ parameter is undefined, a default error message is assigned.
334362
<!-- YAML
335363
added: v0.1.21
336364
-->
365+
* `actual` {any}
366+
* `expected` {any}
367+
* `message` {any}
337368

338369
Tests strict inequality as determined by the strict not equal operator
339370
( `!==` ).
@@ -359,6 +390,8 @@ If the values are strictly equal, an `AssertionError` is thrown with a
359390
<!-- YAML
360391
added: v0.1.21
361392
-->
393+
* `value` {any}
394+
* `message` {any}
362395

363396
Tests if `value` is truthy. It is equivalent to
364397
`assert.equal(!!value, true, message)`.
@@ -386,6 +419,9 @@ assert.ok(false, 'it\'s false');
386419
<!-- YAML
387420
added: v0.1.21
388421
-->
422+
* `actual` {any}
423+
* `expected` {any}
424+
* `message` {any}
389425

390426
Tests strict equality as determined by the strict equality operator ( `===` ).
391427

@@ -410,6 +446,9 @@ If the values are not strictly equal, an `AssertionError` is thrown with a
410446
<!-- YAML
411447
added: v0.1.21
412448
-->
449+
* `block` {Function}
450+
* `error` {RegExp|Function}
451+
* `message` {any}
413452

414453
Expects the function `block` to throw an error.
415454

0 commit comments

Comments
 (0)