@@ -19,6 +19,7 @@ will be instances of the `AssertionError` class.
1919<!-- YAML
2020added: v0.1.21
2121-->
22+
2223* ` options ` {Object}
2324 * ` message ` {string} If provided, the error message is set to this value.
2425 * ` actual ` {any} The ` actual ` property on the error instance.
@@ -145,6 +146,7 @@ assert.deepEqual(/a/gi, new Date());
145146<!-- YAML
146147added: v0.5.9
147148-->
149+
148150* ` value ` {any} The input that is checked for being truthy.
149151* ` message ` {string|Error}
150152
@@ -174,6 +176,7 @@ changes:
174176 pr-url: https://github.com/nodejs/node/pull/5910
175177 description: Handle non-`Uint8Array` typed arrays correctly.
176178-->
179+
177180* ` actual ` {any}
178181* ` expected ` {any}
179182* ` message ` {string|Error}
@@ -291,6 +294,7 @@ changes:
291294 pr-url: https://github.com/nodejs/node/pull/5910
292295 description: Handle non-`Uint8Array` typed arrays correctly.
293296-->
297+
294298* ` actual ` {any}
295299* ` expected ` {any}
296300* ` message ` {string|Error}
@@ -420,6 +424,7 @@ parameter is an instance of an [`Error`][] then it will be thrown instead of the
420424<!-- YAML
421425added: v10.0.0
422426-->
427+
423428* ` asyncFn ` {Function|Promise}
424429* ` error ` {RegExp|Function}
425430* ` message ` {string}
@@ -476,6 +481,7 @@ changes:
476481 pr-url: https://github.com/nodejs/node/pull/3276
477482 description: The `error` parameter can now be an arrow function.
478483-->
484+
479485* ` fn ` {Function}
480486* ` error ` {RegExp|Function}
481487* ` message ` {string}
@@ -544,6 +550,7 @@ assert.doesNotThrow(
544550<!-- YAML
545551added: v0.1.21
546552-->
553+
547554* ` actual ` {any}
548555* ` expected ` {any}
549556* ` message ` {string|Error}
@@ -583,6 +590,7 @@ parameter is an instance of an [`Error`][] then it will be thrown instead of the
583590<!-- YAML
584591added: v0.1.21
585592-->
593+
586594* ` message ` {string|Error} ** Default:** ` 'Failed' `
587595
588596Throws an ` AssertionError ` with the provided error message or a default error
@@ -614,6 +622,7 @@ changes:
614622 description: Calling `assert.fail()` with more than one argument is
615623 deprecated and emits a warning.
616624-->
625+
617626* ` actual ` {any}
618627* ` expected ` {any}
619628* ` message ` {string|Error}
@@ -680,6 +689,7 @@ changes:
680689 description: Value may now only be `undefined` or `null`. Before all falsy
681690 values were handled the same as `null` and did not throw.
682691-->
692+
683693* ` value ` {any}
684694
685695Throws ` value ` if ` value ` is not ` undefined ` or ` null ` . This is useful when
@@ -733,6 +743,7 @@ changes:
733743 pr-url: https://github.com/nodejs/node/pull/5910
734744 description: Handle non-`Uint8Array` typed arrays correctly.
735745-->
746+
736747* ` actual ` {any}
737748* ` expected ` {any}
738749* ` message ` {string|Error}
@@ -814,6 +825,7 @@ changes:
814825 pr-url: https://github.com/nodejs/node/pull/5910
815826 description: Handle non-`Uint8Array` typed arrays correctly.
816827-->
828+
817829* ` actual ` {any}
818830* ` expected ` {any}
819831* ` message ` {string|Error}
@@ -837,6 +849,7 @@ instead of the `AssertionError`.
837849<!-- YAML
838850added: v0.1.21
839851-->
852+
840853* ` actual ` {any}
841854* ` expected ` {any}
842855* ` message ` {string|Error}
@@ -879,6 +892,7 @@ changes:
879892 pr-url: https://github.com/nodejs/node/pull/17003
880893 description: Used comparison changed from Strict Equality to `Object.is()`
881894-->
895+
882896* ` actual ` {any}
883897* ` expected ` {any}
884898* ` message ` {string|Error}
@@ -916,6 +930,7 @@ changes:
916930 description: The `assert.ok()` (no arguments) will now use a predefined
917931 error message.
918932-->
933+
919934* ` value ` {any}
920935* ` message ` {string|Error}
921936
@@ -978,6 +993,7 @@ assert(0);
978993<!-- YAML
979994added: v10.0.0
980995-->
996+
981997* ` asyncFn ` {Function|Promise}
982998* ` error ` {RegExp|Function|Object|Error}
983999* ` message ` {string}
@@ -1040,6 +1056,7 @@ changes:
10401056 pr-url: https://github.com/nodejs/node/pull/17003
10411057 description: Used comparison changed from Strict Equality to `Object.is()`
10421058-->
1059+
10431060* ` actual ` {any}
10441061* ` expected ` {any}
10451062* ` message ` {string|Error}
@@ -1096,6 +1113,7 @@ changes:
10961113 pr-url: https://github.com/nodejs/node/pull/3276
10971114 description: The `error` parameter can now be an arrow function.
10981115-->
1116+
10991117* ` fn ` {Function}
11001118* ` error ` {RegExp|Function|Object|Error}
11011119* ` message ` {string}
0 commit comments